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

Создает сегмент типа pixel с заданными параметрами. Если при создании сегмента используются различные условия (например, заданы несколько меток), то в сегмент попадет пользователь, который удовлетворяет одновременно всем заданным условиям.

Request

POST

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

Body

application/json

{
    "segment": {
        "name": "string",
        "pixel_id": 0,
        "period_length": 0,
        "times_quantity_operation": "string",
        "times_quantity": 0,
        "utm_source": "string",
        "utm_content": "string",
        "utm_campaign": "string",
        "utm_term": "string",
        "utm_medium": "string"
    }
}

Name

Description

segment*

Type: SegmentRequestPixel

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

SegmentRequestPixel

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

Name	Description
name*	Type: string Название сегмента.
pixel_id*	Type: integer<int32> Идентификатор пикселя.
period_length	Type: integer<int32> Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно). Min value: `1` Max value: `90`
times_quantity	Type: integer<int32> Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Type: string Условие попадания пользователей в сегмент из пикселя. Допустимые значения: `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. `eq` — равно. Пользователь был замечен пикселем M раз за период. `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период.
utm_campaign	Type: string Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content	Type: string Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium	Type: string Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_source	Type: string Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term	Type: string Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

Responses

200 OK

Body

application/json

{
    "segment": {
        "id": 0,
        "name": "string",
        "type": "string",
        "status": "string",
        "create_time": "2022-12-29T18:02:01Z",
        "owner": "string",
        "pixel_id": 0,
        "period_length": 0,
        "times_quantity": 0,
        "times_quantity_operation": "string",
        "utm_source": "string",
        "utm_content": "string",
        "utm_campaign": "string",
        "utm_term": "string",
        "utm_medium": "string"
    }
}

Name

Description

segment

Type: PixelSegment

Сегмент, созданный по пикселю.
Тип для описания сегмента.

PixelSegment

Сегмент, созданный по пикселю.

Name	Description
name*	Type: string Название сегмента.
create_time	Type: string<date-time> Время создания сегмента.
id	Type: integer<int32> Идентификатор сегмента. Укажите данный параметр при обновлении сегмента.
owner	Type: string Логин владельца сегмента.
period_length	Type: integer<int32> Период, за время которого пользователь был замечен пикселем. Допустимые значения (в сутках): от 1 до 90 (включительно).
pixel_id	Type: integer<int32> Идентификатор пикселя.
status	Type: string Статус обработки сегмента. Допустимые значения: `uploaded` — сегмент с данными пользователя загружен. `is_processed` — сегмент с заданными параметрами обрабатывается. `processed` — загрузка и обработка сегмента завершена. Сегмент готов для работы. `processing_failed` — обработка сегмента завершилась с ошибкой. `is_updated` — сегмент обновляется. `few_data` — сегмент содержит мало данных для работы.
times_quantity	Type: integer<int32> Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.
times_quantity_operation	Type: string Условие попадания пользователей в сегмент из пикселя. Допустимые значения: `lt` — меньше. Пользователь был замечен пикселем меньше, чем M раз за период. `eq` — равно. Пользователь был замечен пикселем M раз за период. `gt` — больше. Пользователь был замечен пикселем больше, чем M раз за период.
type	Type: string Тип сегмента. Допустимые значения: `uploading` — сегмент, созданный из файла с пользовательскими данными. `metrika` — сегмент, импортируемый из Яндекс Метрики. `appmetrica` — сегмент, импортируемый из AppMetrica. `lookalike` — сегмент из пользователей, «похожих» на другой сегмент клиента (технология Look-alike). `geo` — cегмент на основе данных о геолокации по полигонам и по окружностям. `pixel` — сегмент, созданный по пикселю.
utm_campaign	Type: string Метка `utm_campaign`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content	Type: string Метка `utm_content`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium	Type: string Метка `utm_medium`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_source	Type: string Метка `utm_source`. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term	Type: string Метка `utm_term`. Может использоваться как условие попадания пользователей в сегмент из пикселя.

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

Создание сегмента из CSV-файла

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