ads.createAds
Создает рекламные объявления.
Этот метод можно вызвать с ключом доступа пользователя.
Требуются права доступа: ads.
Параметры
string
Идентификатор рекламного кабинета.
string
Сериализованный JSON-массив объектов, описывающих создаваемые объявления. Описание объектов ad_specification
см. ниже.
Максимальное допустимое количество объявлений,
создаваемых с помощью одного запроса — 5. Если нужно больше, то можно использовать execute
.
Пример значения data
:
[{
"campaign_id": 123456,
"ad_format": 1,
"cost_type": 0,
"cpc": 2.00,
"category1_id" : 5,
"title": "Test Title",
"link_url" : "https://mysite.com",
"name": "My ad"
}]
ad_specification
campaign_id
Обязательный параметр, int
(числовое значение).
ID кампании, в которой будет создаваться объявление.
ad_format
Обязательный параметр, int
(числовое значение).
Формат объявления:
- •
1
— изображение и текст; - •
2
— большое изображение; - •
4
— продвижение сообществ или приложений, квадратное изображение. Заголовок объявления (title
) должен совпадать с названием сообщества/приложения; - •
8
— специальный формат сообществ; - •
9
— запись в сообществе (рекламная запись может быть создана с помощью методаwall.postAdsStealth
); - •
11
— адаптивный формат.
autobidding
Флаг, может принимать значения 0
или 1
.
Автоматическое управление ценой:
- •
0
— выключено; - •
1
— включено.
autobidding_max_cost
integer
, string
Максимальное ограничение автоматической ставки в рублях с копейками, 0
— снятие ограничения.
cost_type
Флаг, может принимать значения 0
или 1
Способ оплаты:
- •
0
— оплата за переходы; - •
1
— оплата за показы (включая цель «Максимум показов»); - •
3
— оптимизированная оплата за показы.
cpc
Обязательный параметр, дробное число.
Если cost_type
равен 0
— цена за переход. Цена указывается в рублях с копейками в дробной части.
cpm
Обязательный параметр, дробное число.
Если cost_type
равен 1
— цена за 1000 показов. Цена указывается в рублях с копейками в дробной части.
ocpm
Обязательный параметр, дробное число.
Если cost_type
равен 3
— цена за действие для oCPM. Цена указывается в рублях с копейками в дробной части.
goal_type
Int
(числовое значение).
Обязательный параметр, если cost_type
равен 3
.
Тип цели. См. описание возможных значений на отдельной странице.
Примеры создания целей.
impressions_limit
Int
(числовое значение).
Если ad_format
= 9
или 11
и cost_type
= 1
— ограничение количества показов данного объявления на одного пользователя.
Допустимые значения: 1
, 2
, 3
, 5
, 10
, 15
, 20
.
impressions_limited
Флаг
, может принимать значения 0
или 1
.
Если cost_type
равен 1
и impressions_limit
не может быть задан — признак того, что количество показов объявления на одного пользователя ограничено.
- •
0
— нет ограничения; - •
1
— не более 100 показов на одного пользователя.
impressions_limit_period
Int
(числовое значение).
Если ad_format
= 9
или 11
и cost_type
= 1
— может быть задан период ограничения на количество показов на одного пользователя.
Значение задается в секундах, должно быть кратно суткам (86400 секунд), максимум 90 суток
При наступлении нового периода счетчик показов сбрасывается.
- •
0
— отключает сброс счетчика показов.
ad_platform
Рекламные площадки, на которых будет показываться объявление:
- •(если
ad_format
равен1
иcost_type
равен0
):- •
0
— ВКонтакте и сайты-партнёры; - •
1
— только ВКонтакте.
- •
- •(если
ad_format
равен9
):- •
all
— все площадки; - •
desktop
— полная версия сайта; - •
mobile
— мобильный сайт и приложения.
- •
- •(если
ad_format
равен11
):- •
all
— все площадки; - •
desktop
— полная версия сайта; - •
mobile
— мобильный сайт и приложения.
- •
ad_platform_no_wall
Только для ad_format
= 9
или 11
. 1
— не показывать объявление на стенах сообществ (по умолчанию 0
).
ad_platform_no_ad_network
integer
, [0,1]
Только для ad_format
= 9
или 11
. 1
— не показывать объявление в рекламной сети (по умолчанию 0
).
publisher_platforms
Только для ad_format
= 9
или 11
На каких площадках будет показываться объявление:
- •
all
— Все площадки (по умолчанию); - •
social
— Все соцсети (ВКонтакте и Одноклассники); - •
vk
— Только ВКонтакте.
day_limit
Положительное число. Дневной лимит в рублях.
all_limit
Положительное число. Общий лимит в рублях.
category1_id
Положительное число.
ID тематики или подраздела тематики объявления. Если объявление имеет несколько тематик, то дополнительную можно задать в параметре category2_id
. См. ads.getCategories
.
category2_id
положительное число ID тематики или подраздела тематики объявления.
age_restriction
Отображение отметки возрастного ограничения на объявлении.
- •
0
— не отображать отметку; - •
1
— использовать отметку 0+; - •
2
— использовать отметку 6+; - •
3
— использовать отметку 12+; - •
4
— использовать отметку 16+; - •
5
— использовать отметку 18+.
status
Флаг, может принимать значения 0
или 1
Статус рекламного объявления (0
— остановлено, 1
— запущено).
name
Строка длиной от 3 до 60 символов. Название объявления (для использования в рекламном кабинете).
title
Строка длиной от 3 до 33 символов. Для ad_format
= 11
— до 25 символов.
Заголовок объявления. Может быть задан только для некоторых рекламных форматов.
description
Строка длиной от 3 до 70 символов. Для ad_format
= 11
— до 90 символов.
Описание объявления. Может быть задано только для некоторых рекламных форматов.
link_url
Обязательный параметр, строка. Ссылка на рекламируемый объект в формате:
- •
http://yoursite.com
; - •
https://vk.com/wall-22822305_383737
; - •
http://vk.cоm/club1
.
Если в ссылке содержатся строки {ad_id}
или {campaign_id}
, то они заменяются соответственно на ID объявления и ID кампании в момент перехода пользователя по такой ссылке.
link_domain
Строка.
Домен рекламируемого объекта в формате yoursite.com
.
link_title
Строка длиной от 3 до 25 символов. Заголовок рядом с кнопкой/ссылкой. Может быть задан только для некоторых рекламных форматов.
link_button
Идентификатор кнопки объявления. Может быть задан только для некоторых рекламных форматов.
photo
Основное изображение. Может быть передано только для некоторых рекламных форматов. В качестве значения должен быть передан результат загрузки изображения на сервер.
Если ad_format
равен 4 или 5, то этот параметр можно не передавать и в этом случае будет использовано изображение из сообщества или приложения.
photo_icon
Логотип. Может быть передано только для некоторых рекламных форматов. В качестве значения должен быть передан результат загрузки изображения на сервер.
video
Основное видео. Может быть передано только для адаптивного формата. В качестве значения должен быть передан результат загрузки видео на сервер.
repeat_video
Флаг
, может принимать значения 0
или 1
.
Зацикливание видео. Возможные значения:
- •0 — не зацикливать видео;
- •1 — зацикливать видео.
disclaimer_medical
Флаг
, может принимать значения 0
или 1
.
Отображение предупреждения:
«Есть противопоказания. Требуется консультация специалиста.»
- •1 — включить отображение.
disclaimer_specialist
Флаг
, может принимать значения 0
или 1
.
Отображение предупреждения:
«Необходима консультация специалистов.»
- •1 — включить отображение.
disclaimer_supplements
Флаг
, может принимать значения 0
или 1
.
Отображение предупреждения:
«БАД. Не является лекарственным препаратом.»
- •1 — включить отображение.
weekly_schedule_hours
array
Расписание показа объявления по часам. Массив из семи строк. Каждая из строк соответствует дню недели и содержит последовательность символов 0
или 1
. 0
— не показывать объявление в час, номер которого равен позиции символа. 1
— показывать.
При вызове метода с этим параметром также необходимо обязательно указывать параметр weekly_schedule_use_holidays
.
weekly_schedule_use_holidays
Флаг
, может принимать значения 0
или 1
.
Использовать ли расписание воскресенья в праздничные дни.
stats_url
Пиксель внешней статистики. Доступно в избранных кабинетах.
stats_url2
Дополнительный пиксель внешней статистики. Доступно в избранных кабинетах.
Настройки таргетинга
Набор полей, соответствующих настройкам таргетинга. См. описание возможных полей на отдельной странице.
Результат
Возвращает массив объектов - ответов на каждый запрос в массиве data
. Соответствующий объект в выходном массиве имеет свойство id
, соответствующее id
созданного объявления (или 0
в случае неудачи), а также, возможно, поля error_code
и error_desc
, описывающие ошибку, при ее возникновении. Наличие одновременно ненулевого id
и error_code
говорит о том, что объявление было создано, однако, возможно, не все параметры установлены (например, объявление не запущено).
Коды ошибок
В ходе выполнения могут произойти общие ошибки.