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

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

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

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

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

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

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


{
    "segment" : {
        "name" :  < string > ,
        "pixel_id" :  < integer > ,
        "period_length" :  < integer > ,
        "times_quantity_operation" :  < pixel_times_quantity_operation > ,
        "times_quantity" :  < integer > ,
        "utm_source" :  < string > ,
        "utm_content" :  < string > ,
        "utm_campaign" :  < string > ,
        "utm_term" :  < string > ,
        "utm_medium" :  < string > 
    }
}
Параметры Описание
segment Сегмент с заданными параметрами.
segment
name Название сегмента.
pixel_id Идентификатор пикселя.
period_length

Период, за время которого пользователь был замечен пикселем.

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

times_quantity_operation

Условие попадания пользователей в сегмент из пикселя.

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

  • lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  • eq — равно. Пользователь был замечен пикселем M раз за период.
  • gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
times_quantity

Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.

utm_source Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.
Параметры Описание
segment Сегмент с заданными параметрами.
segment
name Название сегмента.
pixel_id Идентификатор пикселя.
period_length

Период, за время которого пользователь был замечен пикселем.

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

times_quantity_operation

Условие попадания пользователей в сегмент из пикселя.

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

  • lt — меньше. Пользователь был замечен пикселем меньше, чем M раз за период.
  • eq — равно. Пользователь был замечен пикселем M раз за период.
  • gt — больше. Пользователь был замечен пикселем больше, чем M раз за период.
times_quantity

Пороговое значение (M). С этим значением сравнивается количество раз, когда пользователь был замечен пикселем за период.

utm_source Метка utm_source. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_content Метка utm_content. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_campaign Метка utm_campaign. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_term Метка utm_term. Может использоваться как условие попадания пользователей в сегмент из пикселя.
utm_medium Метка utm_medium. Может использоваться как условие попадания пользователей в сегмент из пикселя.

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

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

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


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