Описание типа segment

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

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "hashed" :  < boolean > ,
    "content_type" :  < segment_content_type > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
hashed	Является ли захешированной каждая строка загруженного файла. Возможные значения 0 — строка не захеширована; 1 — строка захеширована.
content_type	Вид содержимого файла. Возможные значения idfa_gaid — идентификаторы устройств; mac — MAC-адреса; crm — CRM-данные.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
hashed	Является ли захешированной каждая строка загруженного файла. Возможные значения 0 — строка не захеширована; 1 — строка захеширована.
content_type	Вид содержимого файла. Возможные значения idfa_gaid — идентификаторы устройств; mac — MAC-адреса; crm — CRM-данные.

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "metrika_segment_type" :  < metrika_segment_type > ,
    "metrika_segment_id" :  < long > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
metrika_segment_type	Вид объекта в Метрике, из которого создается сегмент для Аудиторий. Возможные значения counter_id — счетчик. goal_id — цель; segment_id — сегмент;
metrika_segment_id	Идентификатор объекта из Метрики.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
metrika_segment_type	Вид объекта в Метрике, из которого создается сегмент для Аудиторий. Возможные значения counter_id — счетчик. goal_id — цель; segment_id — сегмент;
metrika_segment_id	Идентификатор объекта из Метрики.

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "app_metrica_segment_type" :  < app_metrica_segment_type > ,
    "app_metrica_segment_id" :  < int > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
app_metrica_segment_type	Вид объекта в AppMetrica, из которого создается сегмент для Аудиторий. Возможные значения api_key — приложение; segment_id — сегмент.
app_metrica_segment_id	Идентификатор объекта из AppMetrica.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
app_metrica_segment_type	Вид объекта в AppMetrica, из которого создается сегмент для Аудиторий. Возможные значения api_key — приложение; segment_id — сегмент.
app_metrica_segment_id	Идентификатор объекта из AppMetrica.

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "lookalike_link" :  < integer > ,
    "lookalike_value" :  < integer > ,
    "maintain_device_distribution" :  < boolean > ,
    "maintain_geo_distribution" :  < boolean > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
lookalike_link	Идентификатор сегмента, на который должен быть похож созданный сегмент.
lookalike_value	Степень «похожести». Принимает значения 1 2 3 4 5.
maintain_device_distribution	Распределение пользователей по типу устройств. Допустимые значения: true — распределение пользователей по типу устройств сохраняется, если это возможно; false — распределение пользователей по типу устройств не сохраняется. Значение по умолчанию: true.
maintain_geo_distribution	Распределение пользователей по городу. Допустимые значения: true — распределение пользователей по городу сохраняется, если это возможно; false — распределение пользователей по городу не сохраняется. Значение по умолчанию: true.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
lookalike_link	Идентификатор сегмента, на который должен быть похож созданный сегмент.
lookalike_value	Степень «похожести». Принимает значения 1 2 3 4 5.
maintain_device_distribution	Распределение пользователей по типу устройств. Допустимые значения: true — распределение пользователей по типу устройств сохраняется, если это возможно; false — распределение пользователей по типу устройств не сохраняется. Значение по умолчанию: true.
maintain_geo_distribution	Распределение пользователей по городу. Допустимые значения: true — распределение пользователей по городу сохраняется, если это возможно; false — распределение пользователей по городу не сохраняется. Значение по умолчанию: true.

Формат ответа

Сегмент, созданный с помощью математических операций из других сегментов.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "composition_type" :  < composition_type > ,
    "composition_parts" : [  < integer > , ... ]
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
composition_type	Операция над сегментами. Возможные значения intersect — пересечение; subtract — вычитание; union — объединение.
composition_parts	Идентификаторы сегментов, которые являются аргументами операции.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
composition_type	Операция над сегментами. Возможные значения intersect — пересечение; subtract — вычитание; union — объединение.
composition_parts	Идентификаторы сегментов, которые являются аргументами операции.

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "geo_segment_type" :  < geo_segment_type > ,
    "times_quantity" :  < integer > ,
    "period_length" :  < integer > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
geo_segment_type	Тип координат для создания сегмента. Возможные значения last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
times_quantity	Частота посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Примечание. Учитывается только одно посещение в сутки.
period_length	Период посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Допустимые значения периода (в сутках): от 1 до 90 (включительно).


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
geo_segment_type	Тип координат для создания сегмента. Возможные значения last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
times_quantity	Частота посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Примечание. Учитывается только одно посещение в сутки.
period_length	Период посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Допустимые значения периода (в сутках): от 1 до 90 (включительно).

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "geo_segment_type" :  < geo_segment_type > ,
    "times_quantity" :  < integer > ,
    "period_length" :  < integer > ,
    "polygons" : [ {
        "points" : [ {
            "latitude" :  < big_decimal > ,
            "longitude" :  < big_decimal > ,
            "description" :  < string > 
        }, ... ]
    }, ... ]
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
geo_segment_type	Тип координат для создания сегмента. Возможные значения last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
times_quantity	Частота посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Примечание. Учитывается только одно посещение в сутки.
period_length	Период посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Допустимые значения периода (в сутках): от 1 до 90 (включительно).
polygons	Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.
Параметры	Описание
points	Координаты точек.
Параметры	Описание
latitude	Широта.
longitude	Долгота.
description	Произвольный комментарий, длина которого не превышает 200.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
geo_segment_type	Тип координат для создания сегмента. Возможные значения last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
times_quantity	Частота посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Примечание. Учитывается только одно посещение в сутки.
period_length	Период посещений указанных мест. Параметр необходим для создания условия «Пользователь посетил указанные места N раз за период». Допустимые значения периода (в сутках): от 1 до 90 (включительно).
polygons	Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.
Параметры	Описание
points	Координаты точек.
Параметры	Описание
latitude	Широта.
longitude	Долгота.
description	Произвольный комментарий, длина которого не превышает 200.

Формат ответа

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


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "pixel_id" :  < integer > ,
    "period_length" :  < integer > ,
    "times_quantity" :  < integer > ,
    "times_quantity_operation" :  < pixel_times_quantity_operation > ,
    "utm_source" :  < string > ,
    "utm_content" :  < string > ,
    "utm_campaign" :  < string > ,
    "utm_term" :  < string > ,
    "utm_medium" :  < string > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
pixel_id	Идентификатор пикселя.
period_length	Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
times_quantity	Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Условие попадания пользователей в сегмент из пикселя. Возможные значения lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. eq — равно. Пользователь был замечен пикселем M раз за период. gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
utm_source	Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content	Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign	Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term	Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium	Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.
pixel_id	Идентификатор пикселя.
period_length	Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
times_quantity	Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Условие попадания пользователей в сегмент из пикселя. Возможные значения lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. eq — равно. Пользователь был замечен пикселем M раз за период. gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
utm_source	Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content	Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign	Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term	Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium	Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.

Формат ответа

no description


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > 
}


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.


Параметры	Описание
id	Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
name	Название сегмента.
status	Статус обработки сегмента. Возможные значения: uploaded — сегмент с данными пользователя загружен; is_processed — сегмент с заданными параметрами обрабатывается; processed — загрузка и обработка сегмента завершена. Сегмент готов для работы; processing_failed — обработка сегмента завершилась с ошибкой; is_updated — сегмент обновляется; few_data — сегмент содержит мало данных для работы.
create_time	Время создания сегмента.
owner	Логин владельца сегмента.