Создание атрибутов

Создает атрибуты клиентов и заказов. При создании пользовательских атрибутов не используйте идентификаторы системных атрибутов. Чтобы получить список идентификаторов системных атрибутов, используйте метод GET /cdp/api/v1/counter/{counterId}/schema/attributes.

Синтаксис запроса

counterId — идентификатор счетчика.

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/attributes
 ? entity_type=<system_entity_namespace>

entity_type *

принадлежность атрибутов.

Допустимые значения:

CONTACT — принадлежность контактам.
COMPANY — принадлежность компаниям.
ORDER — принадлежность заказам.
SIMPLE_ORDER — принадлежность простым заказам.

^* Обязательный параметр

В теле запроса


--data '{
        "attributes": [
            {
                "name": "dates_of_meetings",
                "type_name": "date",
                "multivalued": true,
                "humanized": "Даты обращений в магазин"
            },
            {
                "name": "age",
                "type_name": "numeric",
                "multivalued": false,
                "humanized": "Возраст"
            },
            {
                "name": "first_seen",
                "type_name": "date",
                "multivalued": false,
                "humanized": "Первый заказ"
            }
        ]
    }'


Параметры	Описание
attributes	Cписок атрибутов.
attributes
name	Идентификатор атрибута.
type_name	Идентификатор типа атрибута.
type_group	Группа данного типа атрибута, может вычисляться автоматически по значению поля `type_name`. Не чувствителен к регистру. Возможные значения: PREDEFINED — скалярный тип атрибута. Примеры значений `type_name`: `numeric`, `date`, `datetime`, `email`, `text`. CUSTOM_LIST — произвольный тип атрибута. SYSTEM_LIST — список продуктов, `type_name`: `product`.
multivalued	Определяет, может ли атрибут иметь несколько значений.
humanized	Название атрибута.


Параметры	Описание
attributes	Cписок атрибутов.
attributes
name	Идентификатор атрибута.
type_name	Идентификатор типа атрибута.
type_group	Группа данного типа атрибута, может вычисляться автоматически по значению поля `type_name`. Не чувствителен к регистру. Возможные значения: PREDEFINED — скалярный тип атрибута. Примеры значений `type_name`: `numeric`, `date`, `datetime`, `email`, `text`. CUSTOM_LIST — произвольный тип атрибута. SYSTEM_LIST — список продуктов, `type_name`: `product`.
multivalued	Определяет, может ли атрибут иметь несколько значений.
humanized	Название атрибута.

Пример запроса

POST https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/attributes?entity_type=CONTACT

Формат ответа


{
    "success" :  < boolean > 
}


Параметры	Описание
success	Результат выполнения операции.