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

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

Request

POST

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

Body

application/json
{
  "segment": {
    "name": "example",
    "lookalike_link": 0,
    "lookalike_value": 1,
    "maintain_device_distribution": true,
    "maintain_geo_distribution": true
  }
}

Name

Description

segment

Type: SegmentRequestLookalike

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

Example
{
  "name": "example",
  "lookalike_link": 0,
  "lookalike_value": 1,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

SegmentRequestLookalike

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

Name

Description

lookalike_link

Type: integer

Идентификатор сегмента, на который должен быть похож созданный сегмент.

lookalike_value

Type: integer

Степень "похожести". Принимает значения 1 2 3 4 5.

Min value: 1

Max value: 5

name

Type: string

Название сегмента.

Example: example

maintain_device_distribution

Type: boolean

Распределение пользователей по типу устройств. Допустимые значения:

  • true — распределение пользователей по типу устройств сохраняется, если это возможно.
  • false — распределение пользователей по типу устройств не сохраняется.

Значение по умолчанию: true.

maintain_geo_distribution

Type: boolean

Распределение пользователей по городу. Допустимые значения:

  • true — распределение пользователей по городу сохраняется, если это возможно.
  • false — распределение пользователей по городу не сохраняется.

Значение по умолчанию: true.
Example
{
  "name": "example",
  "lookalike_link": 0,
  "lookalike_value": 1,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

Responses

200 OK

OK

Body

application/json
{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0,
    "lookalike_link": 0,
    "lookalike_value": 0,
    "maintain_device_distribution": true,
    "maintain_geo_distribution": true
  }
}

Name

Description

segment

Type: LookalikeSegment

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

Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

BaseSegment

Тип для описания сегмента.

Name

Description

name

Type: string

Название сегмента.

Example: example

create_time

Type: string<date-time>

Время создания сегмента.

Example: 2025-01-01T00:00:00Z

id

Type: integer

Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.

owner

Type: string

Логин владельца сегмента.

Example: example

status

Type: string

Статус обработки сегмента. Допустимые значения:

  • uploaded — сегмент с данными пользователя загружен.
  • is_processed — сегмент с заданными параметрами обрабатывается.
  • processed — загрузка и обработка сегмента завершена. Сегмент готов для работы.
  • processing_failed — обработка сегмента завершилась с ошибкой.
  • is_updated — сегмент обновляется.
  • few_data — сегмент содержит мало данных для работы.

Example: example

type

Type: string

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

  • uploading — сегмент, созданный из файла с пользовательскими данными.
  • metrika — сегмент, импортируемый из Яндекс Метрики.
  • appmetrica — сегмент, импортируемый из AppMetrica.
  • lookalike — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike).
  • geo — сегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

Example: example
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

LookalikeSegment

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

All of 2 types

  • Type: BaseSegment

    Тип для описания сегмента.

    Example
    {
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}
  • Type: object

    lookalike_link

    Type: integer

    Идентификатор сегмента, на который должен быть похож созданный сегмент.

    lookalike_value

    Type: integer

    Степень "похожести". Принимает значения 1 2 3 4 5.

    maintain_device_distribution

    Type: boolean

    Распределение пользователей по типу устройств. Допустимые значения:

    • true — распределение пользователей по типу устройств сохраняется, если это возможно.
    • false — распределение пользователей по типу устройств не сохраняется.

    Значение по умолчанию: true.

    maintain_geo_distribution

    Type: boolean

    Распределение пользователей по городу. Допустимые значения:

    • true — распределение пользователей по городу сохраняется, если это возможно.
    • false — распределение пользователей по городу не сохраняется.

    Значение по умолчанию: true.
    Example
    {
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "lookalike_link": 0,
  "lookalike_value": 0,
  "maintain_device_distribution": true,
  "maintain_geo_distribution": true
}

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

Предыдущая
Создание сегмента из объекта метрики
Следующая
Создание сегмента с типом "геолокация-полигоны"