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

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

Request

POST

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

Body

application/json

{
    "segment": {
        "name": "string",
        "polygons": [
            {
                "points": [
                    {
                        "latitude": 0,
                        "longitude": 0,
                        "description": "string"
                    }
                ]
            }
        ],
        "period_length": 0,
        "times_quantity": 0,
        "geo_segment_type": "string"
    }
}

Name

Description

segment*

Type: SegmentRequestGeoPolygon

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

SegmentRequestGeoPolygon

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

Name	Description
name*	Type: string Название сегмента.
polygons*	Type: GeoPolygon[] Список полигонов. Всего в сегмент можно добавить не более 10 полигонов. Min items: `1` Max items: `10`
geo_segment_type	Type: string Тип координат. Допустимые значения: `last` — актуальные координаты. В сегмент попадут пользователи, которые находятся на выбранной территории прямо сейчас, или находились там не более часа назад. `regular` — регулярные координаты. В сегмент попадут пользователи, которые регулярно бывают на выбранной территории. Например, живут или работают рядом. При подборе учитываются данные за последние 45 дней. `home` — координаты дома. В сегмент попадут пользователи, которые живут на выбранной территории. `work` — координаты работы. В сегмент попадут пользователи, которые работают на выбранной территории. `condition` — условие "Пользователь посетил указанные места N раз за период". В сегмент попадут пользователи, которые выполнили заданное условие.
period_length	Type: integer<int32> Период посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Допустимые значения периода (в сутках): от 1 до 90 (включительно).
times_quantity	Type: integer<int32> Частота посещений указанных мест. Параметр необходим для создания условия "Пользователь посетил указанные места N раз за период". Примечание Учитывается только одно посещение в сутки.

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 Долгота.

Responses

200 OK

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "geo_segment_type": "string",
        "times_quantity": 0,
        "period_length": 0,
        "polygons": [
            {
                "points": [
                    {
                        "latitude": 0,
                        "longitude": 0,
                        "description": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

segment

Type: PolygonGeoSegment

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

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

Была ли статья полезна?

Создание сегмента с типом "lookalike"

Создание сегмента с типом "геолокация-окружности"