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

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

Request

POST

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

Body

application/json
{
  "segment": {
    "name": "example",
    "polygons": [
      {
        "points": [
          {},
          {},
          {},
          {}
        ],
        "description": "example"
      }
    ],
    "period_length": 0,
    "times_quantity": 0,
    "geo_segment_type": "example",
    "device_matching_type": "example"
  }
}

Name

Description

segment

Type: SegmentRequestGeoPolygon

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

Example
{
  "name": "example",
  "polygons": [
    {
      "points": [
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        }
      ],
      "description": "example"
    }
  ],
  "period_length": 0,
  "times_quantity": 0,
  "geo_segment_type": "example",
  "device_matching_type": "example"
}

GeoPoint

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

Name

Description

description

Type: string

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

Min length: 0

Max length: 200

Example: example

latitude

Type: number

Широта.

longitude

Type: number

Долгота.
Example
{
  "latitude": 0.5,
  "longitude": 0.5,
  "description": "example"
}

GeoPolygon

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

Name

Description

points

Type: GeoPoint[]

Min items: 4

Max items: 2147483647

Example
[
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  },
  {
    "latitude": 0.5,
    "longitude": 0.5,
    "description": "example"
  }
]
Example
{
  "points": [
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    },
    {
      "latitude": 0.5,
      "longitude": 0.5,
      "description": "example"
    }
  ]
}

SegmentRequestGeoPolygon

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

Name

Description

name

Type: string

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

Example: example

polygons

Type: GeoPolygon[]

Min items: 1

Max items: 10

Example
[
  {
    "points": [
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      }
    ],
    "description": "example"
  }
]

geo_segment_type

Type: string

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

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

Example: example

period_length

Type: integer

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

times_quantity

Type: integer

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

Примечание

Учитывается только одно посещение в сутки.
Example
{
  "name": "example",
  "polygons": [
    {
      "points": [
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        }
      ],
      "description": "example"
    }
  ],
  "period_length": 0,
  "times_quantity": 0,
  "geo_segment_type": "example"
}

Responses

200 OK

OK

Body

application/json
{
  "segment": {
    "type": "example",
    "id": 0,
    "name": "example",
    "status": "example",
    "create_time": "2025-01-01T00:00:00Z",
    "owner": "example",
    "has_guests": true,
    "guest_quantity": 0,
    "can_create_dependent": true,
    "has_derivatives": true,
    "derivatives": [
      0
    ],
    "cookies_matched_quantity": 0,
    "geo_segment_type": "example",
    "times_quantity": 0,
    "period_length": 0,
    "form": "example",
    "polygons": [
      {
        "points": [
          null,
          null,
          null,
          null
        ],
        "description": "example"
      }
    ],
    "pattern": "example",
    "too_much_data": true
  }
}

Name

Description

segment

Type: PolygonGeoSegment

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

Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "form": "example",
  "polygons": [
    {
      "points": [
        {},
        {},
        {},
        {}
      ],
      "description": "example"
    }
  ],
  "pattern": "example",
  "too_much_data": true
}

BaseSegment

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

Name

Description

name

Type: string

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

Example: example

create_time

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

id

Type: integer

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

owner

Type: string

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

Example: example

status

Type: string

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

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

Example: example

type

Type: string

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

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

Example: example
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example"
}

PolygonGeoSegment

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

All of 2 types

  • Type: BaseSegment

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

    Example
    {
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0
}
  • Type: object

    geo_segment_type

    Type: string

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

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

    Example: example

    period_length

    Type: integer

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

    polygons

    Type: GeoPolygon[]

    Example
    [
  {
    "points": [
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      },
      {
        "latitude": 0.5,
        "longitude": 0.5,
        "description": "example"
      }
    ],
    "description": "example"
  }
]

    times_quantity

    Type: integer

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

    Примечание

    Учитывается только одно посещение в сутки.
    Example
    {
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "polygons": [
    {
      "points": [
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        },
        {
          "latitude": 0.5,
          "longitude": 0.5,
          "description": "example"
        }
      ],
      "description": "example"
    }
  ]
}
Example
{
  "type": "example",
  "id": 0,
  "name": "example",
  "status": "example",
  "create_time": "2025-01-01T00:00:00Z",
  "owner": "example",
  "has_guests": true,
  "guest_quantity": 0,
  "can_create_dependent": true,
  "has_derivatives": true,
  "derivatives": [
    0
  ],
  "cookies_matched_quantity": 0,
  "geo_segment_type": "example",
  "times_quantity": 0,
  "period_length": 0,
  "polygons": [
    {
      "points": [
        {},
        {},
        {},
        {}
      ],
      "description": "example"
    }
  ]
}

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

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