• Создана пользователем пользователь-1e7cc. Последнее обновление: авг. 02, 2023 ( пользователь-07453) Время чтения: 2 мин.

Объекты

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 и их конфигурацию.
Для получения списка объектов со всеми существующими полями следует использовать метод:
 

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


Ответ:
 

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

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

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>



При использование  запроса 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
}
}


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

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>


Пример:

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.

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

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>


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

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
}'


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

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>

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

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>'
  • Нет меток