Создание сегмента с типом "lookalike"

Создает сегмент типа lookalike с заданными параметрами.

Request

POST

https://api-audience.yandex.ru/v1/management/segments/create_lookalike

Body

application/json

{
    "segment": {
        "name": "string",
        "lookalike_link": 0,
        "lookalike_value": 0,
        "maintain_device_distribution": false,
        "maintain_geo_distribution": false
    }
}

Name

Description

segment*

Type: SegmentRequestLookalike

Сегмент с заданными параметрами.

SegmentRequestLookalike

Сегмент с заданными параметрами.

Name	Description
lookalike_link*	Type: integer<int32> Идентификатор сегмента, на который должен быть похож созданный сегмент.
lookalike_value*	Type: integer<int32> Степень "похожести". Принимает значения 1 2 3 4 5. Min value: `1` Max value: `5`
name*	Type: string Название сегмента.
maintain_device_distribution	Type: boolean Распределение пользователей по типу устройств. Допустимые значения: `true` — распределение пользователей по типу устройств сохраняется, если это возможно. `false` — распределение пользователей по типу устройств не сохраняется. Значение по умолчанию: `true`.
maintain_geo_distribution	Type: boolean Распределение пользователей по городу. Допустимые значения: `true` — распределение пользователей по городу сохраняется, если это возможно. `false` — распределение пользователей по городу не сохраняется. Значение по умолчанию: `true`.

Responses

200 OK

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "lookalike_link": 0,
        "lookalike_value": 0,
        "maintain_device_distribution": false,
        "maintain_geo_distribution": false
    }
}

Name

Description

segment

Type: LookalikeSegment

Сегмент из пользователей, "похожих" на другой сегмент клиента (технология Look-alike).
Тип для описания сегмента.

LookalikeSegment

Сегмент из пользователей, "похожих" на другой сегмент клиента (технология Look-alike).

Name	Description
name*	Type: string Название сегмента.
create_time	Type: string<date-time> Время создания сегмента.
id	Type: integer<int32> Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
lookalike_link	Type: integer<int32> Идентификатор сегмента, на который должен быть похож созданный сегмент.
lookalike_value	Type: integer<int32> Степень "похожести". Принимает значения 1 2 3 4 5.
maintain_device_distribution	Type: boolean Распределение пользователей по типу устройств. Допустимые значения: `true` — распределение пользователей по типу устройств сохраняется, если это возможно. `false` — распределение пользователей по типу устройств не сохраняется. Значение по умолчанию: `true`.
maintain_geo_distribution	Type: boolean Распределение пользователей по городу. Допустимые значения: `true` — распределение пользователей по городу сохраняется, если это возможно. `false` — распределение пользователей по городу не сохраняется. Значение по умолчанию: `true`.
owner	Type: string Логин владельца сегмента.
status	Type: string Статус обработки сегмента. Допустимые значения: `uploaded` — сегмент с данными пользователя загружен. `is_processed` — сегмент с заданными параметрами обрабатывается. `processed` — загрузка и обработка сегмента завершена. Сегмент готов для работы. `processing_failed` — обработка сегмента завершилась с ошибкой. `is_updated` — сегмент обновляется. `few_data` — сегмент содержит мало данных для работы.
type	Type: string Тип сегмента. Допустимые значения: `uploading` — сегмент, созданный из файла с пользовательскими данными. `metrika` — сегмент, импортируемый из Яндекс Метрики. `appmetrica` — сегмент, импортируемый из AppMetrica. `lookalike` — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike). `geo` — cегмент на основе данных о геолокации по полигонам и по окружностям. `pixel` — сегмент, созданный по пикселю.

Была ли статья полезна?

Создание сегмента из объекта метрики

Создание сегмента с типом "геолокация-полигоны"