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

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

Пример тела запроса
--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": "Первый заказ"
            }
        ]
    }'

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/schema/attributes

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика.
Example: 2215573

Query parameters

Name

Description

entity_type*

Type: string

Принадлежность атрибутов.
Возможные значения:

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

Body

application/json
{
    "attributes": [
        {
            "name": "string",
            "type_name": "string",
            "type_group": "string",
            "type_humanized": "string",
            "multivalued": false,
            "humanized": "string"
        }
    ]
}

Name

Description

attributes*

Type: Attribute[]

Атрибуты списка.
Описание объекта Attribute.

Attribute

Описание объекта Attribute.

Name

Description

multivalued*

Type: boolean

Определяет, может ли атрибут иметь несколько значений.

name*

Type: string

Идентификатор атрибута.

Min length: 1

Max length: 255

Pattern: ^[\w-:]+$

humanized

Type: string

Название атрибута.

Min length: 0

Max length: 4096

type_group

Type: string

Группа типа атрибута. Возможные значения:

  • PREDEFINED — скалярный тип атрибута. Примеры значений type_name: numeric, date, datetime, email, text.
  • CUSTOM_LIST — произвольный тип атрибута.
  • SYSTEM_LIST — список продуктов, type_name: product.

type_humanized

Type: string

Название типа атрибута.

type_name

Type: string

Идентификатор типа атрибута.

Responses

200 OK

OK

Body

application/json
{
    "success": true
}

Name

Description

success

Type: boolean

Результат выполнения операции.

Default: true

No longer supported, please use an alternative and newer version.