Сохранение сегмента из ClientId Метрики, созданного из файла

Сохраняет сегмент из ClientId Метрики, созданный из файла с данными.

Request

POST

https://api-audience.yandex.ru/v1/management/segment/client_id/{segmentId}/confirm

Path parameters

Name

Description

segmentId

Type: integer

Идентификатор сегмента, который вы хотите сохранить.

Body

application/json
{
  "segment": {
    "name": "example",
    "counter_id": 0
  }
}

Name

Description

segment

Type: ClientIdSegmentRequestUploading

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

Example
{
  "name": "example",
  "counter_id": 0
}

ClientIdSegmentRequestUploading

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

Name

Description

counter_id

Type: integer

ID счетчика.

name

Type: string

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

Example: example
Example
{
  "name": "example",
  "counter_id": 0
}

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",
    "hashed": true,
    "used_hashing_alg": "example",
    "content_type": "example"
  }
}

Name

Description

segment

Type: UploadingSegment

Сегмент, созданный из файла с пользовательскими данными.

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

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"
}

UploadingSegment

Сегмент, созданный из файла с пользовательскими данными.

All of 2 types

  • Type: BaseSegment

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

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

    content_type

    Type: string

    Вид содержимого файла. Допустимые значения:

    • idfa_gaid — идентификаторы устройств.
    • mac — MAC-адреса.
    • crm — CRM-данные.

    Example: example

    hashed

    Type: boolean

    Является ли захешированной каждая строка загруженного файла. Допустимые значения:

    • true — строка захеширована.
    • false — строка не захеширована.

    used_hashing_alg

    Type: string

    Алгоритм хеширования примененный для данных, отправляется для hashed: true. Допустимые значения: SHA256.

    Внимание

    С января 2025 года загрузка новых хешей MD5 не поддерживается. Для загрузки данных используйте SHA‑256.

    Example: example
    Example
    {
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example"
}
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "hashed": true,
  "used_hashing_alg": "example",
  "content_type": "example"
}
Предыдущая
Сохранение сегмента, созданного из файла
Следующая
Список доступных сегментов