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

  1. Добавление рекламной кампании
  2. Размещение кампании на сайте
  3. Добавление баннера в рекламную кампанию

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

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

Сначала добавим рекламную кампанию:

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

    https://api.adfox.ru/v1/API.php?loginAccount=*&loginPassword=**

    где * — логин пользователя, ** — хеш функция sha256 от пароля.

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

    Для этого:

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

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

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

    object=account&action=add&actionObject=campaign
  4. Далее добавляем обязательные параметры и заполняем их, также при необходимости добавляем необязательные параметры метода.

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

    https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=add&actionObject=campaign&name=April_16_tea&advertiserID=456&dateStart=2016-12-20 06:30&dateEnd=2016-12-31 22:30

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

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

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

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

    https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=placing&actionObject=website

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

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

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

    https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=website

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

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

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

    https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=placing&actionObject=website&objectID=474205&actionStatus=1&actionObjectID=3245

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

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

  1. Добавляем в строку запроса блок обращения к хосту, блок авторизации и навигации:
    https://api.adfox.ru/v1/API.php?loginAccount=*&loginPassword=**object=account&action=add&actionObject=banner
  2. Находим в документе обязательные и, при необходимости, необязательные параметры метода для настройки открутки баннера.
  3. Окончательный запрос для добавления баннера будет таким:
    https://api.adfox.ru/v1/API.php?loginAccount=*&loginPassword=**object=account&action=add&actionObject=banner&name=aptil2015&campaignID=444444