История страницы

Оглавление

Объекты

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

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

Методы

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

Переменные

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

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

Примеры

Получить список объектов advertiser и их конфигурацию.Выбрать все объекты рекламодателя
Для получения списка объектов со всеми существующими полями следует использовать метод:

Блок кода

language	bash

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

Ответ:

js

Блок кода
language

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

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

Блок кода

language	bash

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

Ответ:

Блок кода

language	js

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

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

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

bash

Блок кода
language

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

Пример:

Блок кода

language	bash

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

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

При использование запроса PUT.

Требуется список обязательных нод:

для создания advertiser.

Пример:

Блок кода

curl --request PUT 'https://ui.getintent.com/api/v2/advertisers/new?token=<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "url": "https://getintent.com/",
  "name": "Test_create_api_new_adver3",
  "credit": 0,
  "currency": "RUB",
  "max_budget": 0,
  "hide_billing": false,
  "margin_optimisation": false,
  "compliant_media_cost": {
    "enabled": false
  },
  "cpa_prediction_enabled": false,
  "default_dsp_commission": "1",
  "cpc_predict_transparent": false,
  "creative_tmt_validation": false,
  "default_agency_commission": "1",
  "omit_expected_discrepancy": false,
  "manage_campaigns_commissions": true,
  "shared_pixel_data_with": [],
  "payment_type": "prepaid",
  "current_balance": 0
}'

Обязательные ноды:

Блок кода

{
"url": "https://getintent.com/",
"name": "Test_create_api_new_adver3",
"currency": "RUB",
"payment_type": "prepaid",
"default_dsp_commission": "1",
"default_agency_commission": "1",
"credit": 0,
"max_budget": 0
}

Для создания campaigns_group.

Обязательные ноды.

Блок кода
{ "name" : "test_group", "budget_limit" : 100 }

Для создания campaigns.

Блок кода

{
"name": "Test campaign!",
"advertiser_id": 3936,
"starts": "2024-11-11 00:00:00",
"ends": "2024-11-12 00:00:00",
"type_ad_campaign": "CPM",
"for_mobile_device": false,
"for_native_ads": false,
"for_video_ads": false,
"for_dooh": false,
"landing_page": "http://getintent.com",
"disabled": true,
"budget": 10,
"financing": {
"type": "max_cpm",
"price": 3.5
}
}

Получить сведения об объекте.

bash

Блок кода
Блок кода
language

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

Пример:

language

Блок кода

bash

curl -X GET https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/get/<entity_id>?token=<token>
или
curl --request GET 'https://ui.getintent.com/api/v2/campaign_groups/get/22629?token=<token>'

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

Требует наличие обязательных нод.

Блок кода

language	bash

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

Пример:

Блок кода

language	bash

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

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

Обновить объект: Одну или несколько нод.

Блок кода

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

Пример:

Блок кода

curl --location --request PATCH 'https://ui.getintent.com/api/v2/advertisers/edit/9703?token=<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test_create_api_new_adver5",
    "current_balance": 3
}'

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

bash

Блок кода
Блок кода
language

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

Пример:

Блок кода

language	bash

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

Восстановить удаленный объект.

Блок кода
PATCH https://ui.getintent.com/api/v2/advertisers/<advertiser_id>/<entity>/delete/<entity_id>?token=<token>

Блок кода
curl --request PATCH 'https://ui.getintent.com/api/v2/advertisers/9703/campaign_groups/restore/22626?token=<token>'

Дерево страниц

Сравнение версий

Старая версия 1

Новая версия Текущий

Ключ

Объекты

Методы

Переменные

Примеры