Создание сегмента с типом «геолокация-полигоны»

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

  1. Синтаксис запроса
  2. В теле запроса
  3. Формат ответа

Синтаксис запроса

https://api-audience.yandex.ru/v1/management/segments/create_geo_polygon
 ? 

В теле запроса


{
    "segment" : {
        "name" :  < string > ,
        "polygons" : [ {
            "points" : [ {
                "latitude" :  < big_decimal > ,
                "longitude" :  < big_decimal > ,
                "description" :  < string > 
            }, ... ]
        }, ... ],
        "period_length" :  < integer > ,
        "times_quantity" :  < integer > ,
        "geo_segment_type" :  < geo_segment_type > 
    }
}
Параметры Описание
segment Сегмент с заданными параметрами.
segment
name Название сегмента.
polygons Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.
period_length

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

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

times_quantity

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

Примечание.

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

geo_segment_type Тип координат для создания сегмента.

Возможные значения:

  • last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад.
  • regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней.
  • home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории.
  • work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории.
  • condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
polygons
points Координаты точек.
points
latitude Широта.
longitude Долгота.
description Произвольный комментарий, длина которого не превышает 200.
Параметры Описание
segment Сегмент с заданными параметрами.
segment
name Название сегмента.
polygons Список полигонов. Всего в сегмент можно добавить не более 10 полигонов.
period_length

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

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

times_quantity

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

Примечание.

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

geo_segment_type Тип координат для создания сегмента.

Возможные значения:

  • last — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад.
  • regular — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней.
  • home — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории.
  • work — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории.
  • condition — условие «Пользователь посетил указанные места N раз за период». В сегмент попадут пользователи, которые выполнили заданное условие.
polygons
points Координаты точек.
points
latitude Широта.
longitude Долгота.
description Произвольный комментарий, длина которого не превышает 200.

Пример запроса

POST https://api-audience.yandex.ru/v1/management/segments/create_geo_polygon?

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


{
    "segment" :  < _polygon_geo_segment > 
}
Параметры Описание
segment Сегмент с заданными параметрами.
Параметры Описание
segment Сегмент с заданными параметрами.