Изменение данных сегмента, созданного из файла

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

Пример запроса
POST https://api-audience.yandex.ru/v1/management/segment/111/modify_data?modification_type=addition
Content-Type: multipart/form-data; boundary=--------------------------5b2a52c5c90f668a
Context-Length: 331
--------------------------5b2a52c5c90f668a
Content-Disposition: form-data; name="file"; filename="data.tsv"
Content-Type: application/octet-stream

aaaaaaaa-bbbb-cccc-1111-222222222200
aaaaaaaa-bbbb-cccc-1111-222222222201
--------------------------5b2a52c5c90f668a--

Request

POST

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

Path parameters

Name

Description

segmentId*

Type: integer<int32>

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

Query parameters

Name

Description

modification_type*

Type: string

Тип изменения данных: добавление или удаление данных, перезаписывание файла целиком. При добавлении данные должны совпадать с исходным форматом (захешированная или незахешированая информация).
Тип изменения данных. Допустимые значения:

  • subtraction — удаление данных из файла.
  • addition — добавление данных в файл.
  • replace — перезаписывание файла целиком.
    Example: addition, subtraction, replace

check_size

Type: boolean

Параметр позволяет создавать сегменты меньше 100 записей. Такие сегменты нельзя использовать для продвижения в Директе, пока их размер не превысит 100 записей.

Default: true

Body

multipart/form-data
{
    "file": null
}

Name

Description

file*

Type: string<binary>

Загружаемый файл с изменением данных.

Responses

200 OK

OK

Body

application/json
{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "hashed": false,
        "used_hashing_alg": "string",
        "content_type": "string"
    }
}

Name

Description

segment

Type: UploadingSegment

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

UploadingSegment

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

Name

Description

name*

Type: string

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

used_hashing_alg*

Type: string

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

  • MD5.
  • SHA256.

Примечание

Начиная с января 2025 года загрузка новых хешей MD5 перестанет поддерживаться. Пожалуйста, используйте SHA256 для загрузки данных.

content_type

Type: string

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

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

create_time

Type: string<date-time>

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

hashed

Type: boolean

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

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

id

Type: integer<int32>

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

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 — сегмент, созданный по пикселю.

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

Предыдущая
Изменение списка координат сегмента с типом "геолокация-окружности"
Следующая
Сохранение сегмента, созданного из файла