Объекты

API рекламодателя поддерживает следующие объекты (некоторые из них являются необязательными):

ОбъектОписание
campaignsРекламные кампании
campaign_groupsГруппы кампаний
creativesКреативы
sitesСайты
domains_listsСписки доменов
snippetsСниппеты
segment_definitionsСегменты

forecast

Статус кампаний и прогноз (использовать с методом "list"

Методы

МетодОписание
allВыбрать все объекты
listРанжировать объекты
getПолучить информацию об объекте
newСоздать новый объект
editОбновить объект
deleteУдалить объект

Переменные

Использование следующих переменных в API рекламодателя является обязательным:

ПеременнаяОписание
<advertiser_id>ID рекламодателя. Важно: настройки рекламодателя могут изменяться в Общем API
<entity>Тип объекта (кампании, сайты и т.п.)
<entity_id>ID объекта
<token> 

Токен для доступа к API. Его можно найти в настройках пользователя. Важно: пользователь должен иметь доступ к рекламодателю с id = <advertiser_id>


Примеры

Выбрать все объекты рекламодателя

Для получения списка объектов со всеми существующими полями следует использовать метод:

GET https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/all?token=<token>

Ответ:

{
    "data": {
       "<entity id>" => {<entity data>},
       ...
    }
}


Список объектов

GET https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/list?token=<token>

Ответ:

{
    "data": {
       "<entity id>" => {<entity data>},
       ...
    }
}

Метод list по умолчанию возвращает только поля «id» и «name» рекламодателя, дополнительные поля в выводе контролируются параметром «custom_fields».


Создать объект

Используйте тип запроса PUT, тело запроса должно содержать соответствующий объект JSON.

PUT https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/new?token=<token> 

Пример:

curl --data '{"name": "entity name", ...}' -X PUT https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/new?token=<token>


Выбрать объект

GET https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/get/<entity_id>?token=<token>

Пример:

curl -X GET https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/get/<entity_id>?token=<token>


Обновить объект

Используйте тип запроса PUT, тело запроса должно содержать соответствующий объект JSON.

PUT https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/edit/<entity_id>?token=<token>

Пример:

curl --data '{"name": "new title"}' -X PUT https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/edit/<entity_id>?token=<token>


Удалить объект

DELETE https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/delete/<entity_id>?token=<token>

Пример:

curl -X DELETE https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/delete/<entity_id>?token=<token>