Создание сегмента из объекта AppMetrica

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

Request

POST

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

Body

application/json

{
  "segment": {
    "name": "example",
    "app_metrica_segment_type": "example",
    "app_metrica_segment_id": 0,
    "device_matching_type": "example"
  }
}

Name

Description

segment

Type: SegmentRequestAppMetrika

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

Example

{
  "name": "example",
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0,
  "device_matching_type": "example"
}

SegmentRequestAppMetrika

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

Name	Description
app_metrica_segment_type	Type: string Вид объекта в AppMetrica. Допустимые значения: `api_key` — приложение. `segment_id` — сегмент. Example: `example`
name	Type: string Название сегмента. Example: `example`
app_metrica_segment_id	Type: integer Идентификатор объекта из AppMetrica.

Example

{
  "name": "example",
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0
}

Responses

200 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,
    "app_metrica_segment_type": "example",
    "app_metrica_segment_id": 0,
    "pattern": "example"
  }
}

Name

Description

segment

Type: AppMetricaSegment

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

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,
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0,
  "pattern": "example"
}

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"
}

AppMetricaSegment

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

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

app_metrica_segment_id

Type: integer

Идентификатор объекта из AppMetrica.

app_metrica_segment_type

Type: string

Вид объекта в AppMetrica. Допустимые значения:

api_key — приложение.
segment_id — сегмент.

Example: example

Example

{
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0
}

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,
  "app_metrica_segment_type": "example",
  "app_metrica_segment_id": 0
}

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

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

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