Получение списка рекламных кампаний
Получение списка рекламных кампаний
| Метод | get.campaigns |
|---|---|
| Описание | Получение списка всех рекламных кампаний - интегрированных, обычных и системных |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Описание |
|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
filter |
object | нет | См. раздел "Критерии фильтрации" |
fields |
array | нет | См. раздел "Представление возвращаемых данных" |
sort |
array | нет | См. раздел "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
id |
number | да | Уникальный идентификатор рекламной кампании | ||
name |
string | да | да | Название рекламной кампании | |
description |
string | Максимум 255 символов | Описание рекламной кампании | ||
status |
enum |
|
да | Статус рекламной кампании | |
creation_time |
iso8601 | YYYY-MM-DD hh:mm:ss | да | да | Дата и время создания рекламной кампании |
campaign_conditions |
object | нет | Условия рекламной кампании. Отсутствует, если поле
|
||
engine |
enum |
|
да | да | Платформа для интегрированной рекламной кампании |
type |
enum |
|
да | да | Типы рекламных кампаний.
|
costs |
number | да | да | Расходы на рекламную кампанию | |
cost_ratio |
number | минимальное значение 1 | Значение по умолчению 1. Коэфициент, который влияет на значение параметра `costs` | ||
cost_ratio_operator |
enum |
|
Значение по умолчанию `wo_changes`. Оператор, который используется при расчете `costs` с учетом `cost_ratio` | ||
| Сайт | |||||
site_id |
number | да | да | Уникальный идентификатор сайта | |
site_domain_name |
string | да | Адрес сайта в интернете. Без указания протокола - "http://" или "https://" | ||
| Настройки привязки номера к блоку на сайте | |||||
site_blocks |
array | да | Настройки привязки номера к блоку на сайте | ||
site_block_id |
number | Уникальный идентификатор блока номеров | |||
site_block_name |
string | Название блока номеров | |||
phone_number_type |
enum |
|
Тип виртуального номера (см. метод get.campaign_available_phone_numbers) для параметра phone_number_id:
|
||
phone_number_id |
number |
Уникальный идентификатор виртуального номера в зависимости от параметра phone_number_type.
Чтобы получить список доступных виртуальных номеров необходимо использовать метод get.campaign_available_phone_numbers
|
|||
phone_number |
string | Номер, который соответствует параметру phone_number_id
|
|||
redirection_phone_number_id |
number |
Номер переадресации, который используется в том случае, если тип номера, который указан в параметре phone_number_id имеет значение call_tracking.
Чтобы получить список доступных номеров для переадресации необходимо использовать метод get.campaign_available_redirection_phone_numbers
|
|||
redirection_phone_number |
string | Номер, который соответствует параметру redirection_phone_number_id
|
|||
static_utm_source |
string | да | Статическая utm-метка source. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_medium |
string | да | Статическая utm-метка medium. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_campaign |
string | да | Статическая utm-метка campaign. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_term |
string | да | Статическая utm-метка term. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_content |
string | да | Статическая utm-метка content. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_referrer |
string | да | Статическая utm-метка referrer. Параметр появится в ответе, только если присутствует в fields запроса |
||
static_utm_expid |
string | да | Статическая utm-метка expid. Параметр появится в ответе, только если присутствует в fields запроса |
||
dynamic_call_tracking_enabled |
boolean | true, false |
Динамический коллтрекинг.
Может принимать значение "true", если параметр
|
||
| Динамический коллтрекинг | |||||
dynamic_call_tracking |
object | да |
Настройки динамического коллтрекинга. Звонки на номера из пула динамического коллтрекинга будут обрабатываться по правилам обработки звонков на номер блока рекламной кампании по умолчанию. |
||
reservation_time |
enum |
|
Значение по умолчанию "15m". Период, на который номер закрепляется за посетителем сайта. По истечении указанного времени номер закрепляется за новым посетителем (или остается за текущим в случае наличия свободных номеров коллтрекинга). |
||
count_virtual_numbers |
number | минимальное значение 1 | Количество номеров необходимое для работы динамического коллтрекинга в одном блоке. Указанное количество номеров будет куплено. | ||
count_visits |
number | минимальное значение 1 | Количество посещений по рекламной кампании в сутки | ||
coverage_visitors |
number | Процент посетителей сайта, которые увидят номер динамического коллтрекинга | |||
| Настройки групп условий | |||||
group_conditions |
array | Группа условий рекламной кампании | |||
| Настройки условий | |||||
conditions |
array | Условия рекламной кампании в группе условий | |||
type |
enum |
|
Условия рекламной кампании в группе условий | ||
campaign_parameter |
enum | Список допустимых значений и возможных операторов см. в таблице "Список параметров и их операторов" | |||
value |
string |
Значение для campaign_parameter. Для некоторых campaign_parameter может быть свой список допустимых значений см. в таблице "Список параметров и их операторов"
|
|||
operator |
enum | =, sub, ~ |
Оператор в условии
|
||
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.campaigns",
"params":{
"access_token":"string",
"user_id":"number",
"offset":"number",
"limit":"number",
"filter":{
},
"sort":[
{
"field":"string",
"order":"string"
}
],
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"id": "number",
"status": "enum",
"creation_time": "iso8601",
"description": "string",
"site_id": "number",
"site_domain_name": "string",
"costs": "number",
"cost_ratio": "number",
"cost_ratio_operator": "enum",
"engine": "enum",
"type": "enum",
"name": "string",
"site_blocks": [
{
"site_block_id": "number",
"site_block_name": "string",
"phone_number_type": "enum",
"phone_number_id": "number",
"phone_number": "string",
"redirection_phone_number_id": "number",
"redirection_phone_number": "string",
"dynamic_call_tracking_enabled": "boolean"
}
],
"dynamic_call_tracking": {
"reservation_time": "enum",
"count_virtual_numbers": "number",
"count_visits": "number"
},
"campaign_conditions": {
"group_conditions": [
{
"conditions": [
{
"type": "enum",
"campaign_parameter": "enum",
"operator": "enum",
"value": "string"
}
]
}
]
}
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"