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

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

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

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


{
    "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.