TD API 2.0 - Adding creative
Метод позволяет добавить креатив в кампанию.
Адрес для отправки запросов:
https://tdm4.adcloud.org/api/v2/?method=MethodName
В качестве get-параметра необходимо передавать название метода, что позволит динамически определить метод через URL-строку.
За предоставлением доступа к методу обратитесь к администратору.
Добавление креатива в рекламную кампанию
"method": "Creative.add" позволяет пользователю добавить креатив в рекламную кампанию. Для этого необходимо выполнить запрос, указав в качестве параметров "campaign_xxhash" - xxhash кампании и параметры нового креатива.
Общие параметры креатива:
Параметр | Тип | Обязательный? | Описание |
|---|---|---|---|
campaign_xxhash | строка | да | ID кампании |
type | строка | да | Тип креатива. Возможные значения: "VIDEO_INLINE", "VIDEO_VAST" |
title | строка | да | Заголовок креатива. |
status | строка | нет | Статус креатива. |
advertiser_name | строка | нет | Имя рекламодателя |
language | строка | нет | Код языка ISO_639-1. |
categories | объект | нет | Категоризация креатива |
-> iab | строка | нет | Категория IAB-каталога первой версии. |
size | строка | да | Размер креатива. |
link | строка | нет | Кликовая ссылка. |
kktu_codes | строка | да | Код классификатора товарных категорий. |
adomain | строка | нет | Конечный URL. |
data | объект | нет | Объект с данными согласно типу креатива. |
Дополнительные параметры по типам креативов
Для разных типов креативов есть дополнительные параметры:
Video
Параметр | Тип | Обязательный? | Описание |
|---|---|---|---|
duration | число | нет | Продолжительность видео, может принимать значение больше 0, но меньше 300. |
skip_duration | число | нет | Продолжительность для пропуска видео, может принимать значение больше 0, но меньше 180. |
video_url | строка | да | Строка в формате URL |
video_bitrate | число | нет | Битрейт видео. Значение можно найти в свойствах видео. |
description | строка | да | Общее описание объекта рекламирования. |
use_vpaid | boolean | да | Для видео mp4, "Использовать VPAID" необходимо включить для отображения ID ЕРИР в видео-рекламе. Подробнее по ссылке |
audit | структура | нет | Структура, содержащая следующие данные: |
extension_link | строка | нет | Дополнительная ссылка перехода |
Video VAST
Параметр | Тип | Обязательный? | Описание |
|---|---|---|---|
duration | число | нет | Продолжительность видео, может принимать значение больше 0, но меньше 300. |
skip_duration | число | нет | Продолжительность для пропуска видео, может принимать значение больше 0, но меньше 300. |
vast_url | строка | да | Строка в формате URL |
description | строка | да | Общее описание объекта рекламирования. |
audit | структура | нет | Структура, содержащая следующие данные: |
extension_link | строка | нет | Дополнительная ссылка перехода |
Пример запроса для типа креатива VIDEO_VAST:
{
"jsonrpc": "2.0",
"method": "Creative.add",
"params": {
"object": {
"campaign_xxhash": "5FBABBBF26444466",
"status": "STOPPED",
"title": "test api 12",
"type": "VIDEO_VAST",
"adomain": "https://mediasniper.ru/",
"link": "https://mediasniper.ru/?us_trk={TR_KEY}",
"extension_link": "https://mediasniper.ru/2",
"kktu_codes": "30.10.1",
"advertiser_name": "advertiser_name",
"size": "240x400",
"data": {
"vast_url":"https://cdn3.terratraf.io/315fd1ab17f8b6ed59fd0ce2b290766b.xml",
"skip_duration": 5,
"description": "mediasniper description",
"audit": {
"show": "https://mediasniper.ru",
"show2": "https://mediasniper2.ru"
}
}
}
},
"id": 1
}Пример ответа:
{
"jsonrpc": "2.0",
"result": {
"id": "7171A571A571A5A5"
},
"id": 1
}Пример запроса для типа креатива VIDEO:
{
"id": 1,
"method": "Creative.add",
"jsonrpc": "2.0",
"params": {
"object": {
"campaign_xxhash": "81X6CADFE205TEST",
"type": "VIDEO_INLINE",
"title": "Видео",
"status": "STOPPED",
"advertiser_name": "Mediasniper",
"data": {
"description": "Mediasniper. Programmatic powerhouse.",
"video_url": "https://cdn3.terratraf.io/20241008/f5ae7459c6b48efd8eb4695d797d7a8c/2f7089fc4450e7804c3b587853821a9b.mp4",
"duration":13,
"skip_duration":12,
"video_bitrate": 1954,
"use_vpaid": true
},
"adomain": "https://mediasniper.ru",
"link": "https://mediasniper.ru/?us_trk={TR_KEY}",
"kktu_codes": "30.10.1",
"language": "ru",
"categories": {
"iab": "3-1"
},
"size":"1920x1080"
}
}
}Пример ответа:
{
"jsonrpc": "2.0",
"result": {
"id": "7272A672A672A6A6"
},
"id": 1
}Метод возвращает в секции результатов ID созданного креатива.
Updated 21 days ago