Изменение сегмента

Изменяет указанный сегмент.

Request

PUT

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

Path parameters

Name

Description

segmentId*

Type: integer<int32>

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

Body

application/json
{
    "segment": {
        "name": "string"
    }
}

Name

Description

segment

Type: SegmentName

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

SegmentName

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

Name

Description

name*

Type: string

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

Responses

200 OK

OK

Body

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

Name

Description

segment

Type: AppMetricaSegment or GeoSegment or LookalikeSegment or MetrikaSegment or PixelSegment or PolygonGeoSegment or UploadingSegment

AppMetricaSegment

Сегмент, импортируемый из AppMetrica.

Name

Description

name*

Type: string

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

app_metrica_segment_id

Type: integer<int32>

Идентификатор объекта из AppMetrica.

app_metrica_segment_type

Type: string

Вид объекта в AppMetrica. Допустимые значения:

  • api_key — приложение.
  • segment_id — сегмент.

create_time

Type: string<date-time>

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

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 — сегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

GeoSegment

Сегмент на основе данных о геолокации по окружностям.

Name

Description

name*

Type: string

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

create_time

Type: string<date-time>

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

geo_segment_type

Type: string

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

  • last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад.
  • regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней.
  • home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории.
  • work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории.
  • condition — условие "Пользователь посетил указанные места N раз за период". В сегмент попадут пользователи, которые выполнили заданное условие.

id

Type: integer<int32>

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

owner

Type: string

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

period_length

Type: integer<int32>

Период посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Допустимые значения периода (в сутках): от 1 до 90 (включительно).

status

Type: string

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

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

times_quantity

Type: integer<int32>

Частота посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период".

Примечание

Учитывается только одно посещение в сутки.

type

Type: string

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

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

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 — сегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

MetrikaSegment

Сегмент, импортируемый из Яндекс Метрики.

Name

Description

name*

Type: string

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

create_time

Type: string<date-time>

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

id

Type: integer<int32>

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

metrika_segment_id

Type: integer<int64>

Идентификатор объекта из Метрики.

metrika_segment_type

Type: string

Вид объекта в Метрике. Допустимые значения:

  • counter_id — счетчик.
  • goal_id — цель.
  • segment_id — сегмент.

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 — сегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

PixelSegment

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

Name

Description

name*

Type: string

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

create_time

Type: string<date-time>

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

id

Type: integer<int32>

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

owner

Type: string

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

period_length

Type: integer<int32>

Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).

pixel_id

Type: integer<int32>

Идентификатор пикселя.

status

Type: string

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

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

times_quantity

Type: integer<int32>

Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.

times_quantity_operation

Type: string

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

  • lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  • eq — равно. Пользователь был замечен пикселем M раз за период.
  • gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.

type

Type: string

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

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

utm_campaign

Type: string

Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.

utm_content

Type: string

Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.

utm_medium

Type: string

Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.

utm_source

Type: string

Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.

utm_term

Type: string

Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.

PolygonGeoSegment

Сегмент на основе данных о геолокации по полигонам.

Name

Description

name*

Type: string

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

create_time

Type: string<date-time>

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

geo_segment_type

Type: string

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

  • last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад.
  • regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней.
  • home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории.
  • work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории.
  • condition — условие "Пользователь посетил указанные места N раз за период". В сегмент попадут пользователи, которые выполнили заданное условие.

id

Type: integer<int32>

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

owner

Type: string

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

period_length

Type: integer<int32>

Период посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Допустимые значения периода (в сутках): от 1 до 90 (включительно).

polygons

Type: GeoPolygon[]

Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.

status

Type: string

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

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

times_quantity

Type: integer<int32>

Частота посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период".

Примечание

Учитывается только одно посещение в сутки.

type

Type: string

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

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

UploadingSegment

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

Name

Description

name*

Type: string

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

used_hashing_alg*

Type: string

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

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

content_type

Type: string

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

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

create_time

Type: string<date-time>

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

device_matching_type

Type: string

Режим поиска устройств для сегмента.

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

  • CROSS_DEVICE — включает в сегмент другие устройства того же пользователя, связанные с загруженным ID. Значение по-умолчанию, если режим поиска не выбран.
  • IN_DEVICE — сегмент строится только по загруженным устройствам, без расширения на другие устройства. На данный момент режим IN_DEVICE доступен только для idfa_gaid сегментов.

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 — сегмент на основе данных о геолокации по полигонам и по окружностям.
  • pixel — сегмент, созданный по пикселю.

GeoPolygon

Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.

Name

Description

points*

Type: GeoPoint[]

Координаты точек.

Min items: 4

Max items: 2147483647

GeoPoint

Координаты точек.

Name

Description

description

Type: string

Произвольный комментарий, длина которого не превышает 200.

Min length: 0

Max length: 200

latitude

Type: number

Широта.

longitude

Type: number

Долгота.

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

Предыдущая
Описание ошибок
Следующая
Удаление сегмента