ads.getAds
Возвращает список рекламных объявлений.
Этот метод можно вызвать с ключом доступа пользователя.
Требуются права доступа: ads.
Параметры
string
Идентификатор рекламного кабинета.
string
Доступно и обязательно для рекламных агентств. Идентификатор клиента, у которого запрашиваются рекламные объявления.
string
Флаг, задающий необходимость вывода архивных объявлений.
- •
0
— выводить только активные объявления; - •
1
— выводить все объявления.
string
string
Фильтр по рекламным кампаниям.
Сериализованный JSON-массив, содержащий id кампаний. Если параметр равен null
, то будут выводиться рекламные объявления всех кампаний.
string
Фильтр по рекламным объявлениям.
Сериализованный JSON-массив, содержащий id объявлений. Если параметр равен null
, то будут выводиться все рекламные объявления.
string
Ограничение на количество возвращаемых объявлений. Используется, только если параметр ad_ids
равен null
, а параметр campaign_ids
содержит ID только одной кампании.
string
Смещение. Используется в тех же случаях, что и параметр limit
.
Замечание
Если одновременно включены фильтры campaign_ids
и ad_ids
, то выведены будут следующие объявления:
- 1.Если ID объявления указано в
ad_ids
, то оно выводится. - 2.Если объявление принадлежит рекламной кампании, чей ID указан в
campaign_ids
, то оно выводится. - 3.Если существует объявление с ID, указанным в
ad_ids
и оно принадлежит кампании, чей ID указан вcampaign_ids
, то эта рекламная кампания игнорируется, т.е. для неё правило 2 не работает.
Выводится не более 2000 объявлений из не более чем 2000 кампаний.
Результат
Возвращает массив объектов, описывающих основные характеристики объявления.
Дополнительные характеристики можно получить при помощи метода ads.getAdsLayout
.
Каждый объект содержит следующие поля:
id
integer
Идентификатор объявления.
campaign_id
integer
Идентификатор кампании.
ad_format
integer
Формат объявления. Возможные значения:
- •
1
— изображение и текст; - •
2
— большое изображение; - •
3
— эксклюзивный формат; - •
4
— продвижение сообществ или приложений, квадратное изображение; - •
5
— приложение в новостной ленте (устаревший); - •
6
— мобильное приложение; - •
9
— запись в сообществе; - •
11
— адаптивный формат; - •
12
— истории.
cost_type
integer
[0
,1
,3
]
Тип оплаты. Возможные значения:
- •
0
— Оплата за переходы; - •
1
— Оплата за показы; - •
3
— Оптимизированная оплата за показы.
cpc
integer
Если cost_type = 0
— цена за переход в копейках.
cpm
integer
Если cost_type = 1
— цена за 1000 показов в копейках.
ocpm
integer
Если cost_type = 3
— цена за действие для oCPM в копейках.
goal_type
integer
Тип цели. См. описание возможных значений на отдельной странице.
impressions_limit
integer
(если задано) Ограничение количества показов данного объявления на одного пользователя. Может присутствовать для некоторых форматов объявлений, для которых разрешена установка точного значения.
impressions_limited
integer
, [1
]
(если задано) Признак того, что количество показов объявления на одного пользователя ограничено. Может присутствовать для некоторых объявлений, для которых разрешена установка ограничения, но не разрешена установка точного значения. 1
— не более 100 показов на одного пользователя.
ad_platform
Если значение применимо к данному формату объявления. Рекламные площадки, на которых будет показываться объявление. Возможные значения:
Если ad_format
равен 1
:
- •
0
— ВКонтакте и сайты-партнёры; - •
1
— только ВКонтакте.
Если ad_format
равен 9
:
- •
all
— все площадки; - •
desktop
— полная версия сайта; - •
mobile
— мобильный сайт и приложения.
Если ad_format
равен 11
:
- •
all
— все площадки; - •
desktop
— полная версия сайта; - •
mobile
— мобильный сайт и приложения.
ad_platform_no_wall
integer
, [1
]
1
— для объявления задано ограничение «Не показывать на стенах сообществ».
ad_platform_no_ad_network
integer
, [1
]
1
— для объявления задано ограничение «Не показывать в рекламной сети».
publisher_platforms
string
Если ad_format
= 9
или 11
На каких площадках показывается объявление:
- •
all
— Все площадки (по умолчанию); - •
social
— Все соцсети (ВКонтакте и Одноклассники); - •
vk
— Только ВКонтакте.
all_limit
integer
Общий лимит объявления в рублях. 0
— лимит не задан.
day_limit
integer
Дневной лимит объявления в рублях. 0
— лимит не задан.
autobidding
Автоматическое управление ценой:
- •
0
— выключено; - •
1
— включено (только для целей «Максимум показов» и «Максимум переходов»).
Флаг, может принимать значения 0
или 1
.
autobidding_max_cost
integer
Максимальное ограничение автоматической ставки в копейках.
category1_id
integer
ID тематики или подраздела тематики объявления. См. ads.getCategories
.
category2_id
integer
ID тематики или подраздела тематики объявления. Дополнительная тематика.
status
integer
Статус объявления. Возможные значения:
- •
0
— объявление остановлено; - •
1
— объявление запущено; - •
2
— объявление удалено.
name
string
Название объявления.
approved
integer
Статус модерации объявления. Возможные значения:
- •
0
— объявление не проходило модерацию; - •
1
— объявление ожидает модерации; - •
2
— объявление одобрено; - •
3
— объявление отклонено.
video
integer
, [1
]
Объявление является видеорекламой.
disclaimer_medical
integer
, [1
]
Включено отображение предупреждения: «Есть противопоказания. Требуется консультация специалиста».
disclaimer_specialist
integer
, [1
]
Включено отображение предупреждения: «Необходима консультация специалистов».
disclaimer_supplements
integer
, [1
]
Включено отображение предупреждения: «БАД. Не является лекарственным препаратом.»
weekly_schedule_hours
array
Расписание показа объявления по часам. Массив из семи строк. Каждая из строк соответствует дню недели и содержит последовательность символов 0
или 1
. 0
— не показывать объявление в час, номер которого равен позиции символа. 1
— показывать.
weekly_schedule_use_holidays
integer
[0
,1
]
1
— использовать расписание воскресенья в праздничные дни.
events_retargeting_groups
array
Только для ad_format
= 9
и 11
. Описание событий, собираемых в группы ретаргетинга. Массив объектов, где ключом является ID группы ретаргетинга, а значением - массив событий. Допустимые значений для событий:
- •
1
— просмотр промопоста; - •
2
— переход по ссылке или переход в сообщество; - •
3
— переход в сообщество; - •
4
— подписка на сообщество; - •
5
— отписка от новостей сообщества; - •
6
— скрытие или жалоба; - •
10
— запуск видео; - •
11
— досмотр видео до 3с; - •
12
— досмотр видео до 25%; - •
13
— досмотр видео до 50%; - •
14
— досмотр видео до 75%; - •
15
— досмотр видео до 100%; - •
20
— лайк продвигаемой записи; - •
21
— репост продвигаемой записи.
Коды ошибок
В ходе выполнения могут произойти общие ошибки.