API рекламодателя

Объекты

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>