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

Допустим, аккаунт уже настроен и требуется начать открутку рекламы.

Добавление рекламной кампании

Сначала добавьте рекламную кампанию по следующим шагам:

1. Добавьте в строку запроса к API блок обращения к хосту:

   https://adfox.yandex.ru/api/v1?
   

2. Найдите в документации API описание метода добавления рекламной кампании.

   Для этого:

   • найдите контекст для добавления объекта. Добавление нового объекта относится только к контексту account;
   • найдите действие для добавления кампании — add;
   • найдите объект, который требуется добавить — campaign.

   Получится такой путь к странице: Версия API → account → add → campaign.

3. Добавьте в строку запроса навигационный блок для добавления кампании:

   object=account&action=add&actionObject=campaign
   

4. Добавьте обязательные и, при необходимости, необязательные параметры метода и заполните их.

5. Окончательный запрос к API для добавления рекламной кампании будет выглядеть так:

   https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=campaign&name=April_16_tea&advertiserID=456&dateStart=2021-12-20 06:30&dateEnd=2021-12-31 22:30
   

   В случае успешного создания кампании в ответе на запрос будет возвращен ID добавленной рекламной кампании.

Размещение кампании на сайте

После добавления кампании требуется включить размещение кампании на сайте, на котором должна происходить открутка рекламы:

1. Добавьте в строку запроса блок обращения к хосту, блок авторизации и навигации:

   https://adfox.yandex.ru/api/v1?object=campaign&action=placing&actionObject=website
   

   Контекстом в данном случае уже будет кампания campaign, действием — размещение placing, а объектом действия — сайт website.

2. Чтобы произвести размещение кампании на сайте, требуется знать ID сайта.

   Если ID неизвестен, получите список сайтов, созданных в контексте аккаунта:

   https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=website
   

   В ответе на запрос вернется список сайтов данного аккаунта.

3. Укажите в запросе обязательные и, при необходимости, необязательные параметры метода.

4. Окончательный запрос на размещение кампании на сайте:

   https://adfox.yandex.ru/api/v1?object=campaign&action=placing&actionObject=website&objectID=474205&actionStatus=1&actionObjectID=3245
   

Добавление баннера в рекламную кампанию

Далее добавьте баннер в рекламную кампанию, созданную на предыдущем шаге:

1. Добавьте в строку запроса блок обращения к хосту, блок авторизации и навигации:

   https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=banner
   

2. Найдите в документе обязательные и, при необходимости, необязательные параметры метода для настройки открутки баннера.

3. Окончательный запрос для добавления баннера будет таким:

   https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=banner&name=aptil2022&campaignID=444444