POST /creatives/

Регистрирует или изменяет креатив.

Формат запроса

POST https://distribution.yandex.net/api/v2/creatives/

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат тела запроса

{
  "clid": {integer},
  "form": {string},
  "text_data": [
    {string}
  ],
  "media_data": [
    {
      "media_url": {string},
      "media_url_file_type" : {string},
      "description": {string}
    }
  ],
  "description": {string}
}
      

Параметры тела запроса

Обязательные параметры

Эти параметры соответствуют полям из интерфейса для создания креатива. Из text_data и media_data достаточно заполнить только одно из полей.

clid

CLID, для которого будет зарегистрирован креатив.

form

Форма распространения рекламы. Допустимые значения:

  • banner – баннер;
  • text-block – текстовый блок;
  • text-graphic-block – текстово-графический блок;
  • video – видеоролик;
  • audio-rec – аудиозапись;
  • live-video – видеотрансляция в прямом эфире;
  • live-audio – аудиотрансляция в прямом эфире.

text_data

Текст креатива.

media_data

Список медиа в рекламном блоке.

media_url

Ссылка на медиа.

media_url_file_type

Тип медиа. Возможные значения:

  • image – изображение;
  • video – video.

description

Описание медиаданных.

description

Описание креатива.

Необязательные параметры

Эти параметры не соответствуют никаким полям из интерфейса и заполняются значениями по умолчанию.

service

Сервис, для которого регистрируется креатив. Используется только если не удалось опредилить креатив из CLIDа. Например, для Яндекс Маркета должно быть значение market.

type

Тип рекламной кампании: cpa, cpc, cpm, other.

token

Токен креатива. Передайте параметр, чтобы изменить креатив.

urls

Cписок целевых ссылок.

okveds

Список кодов ОКВЭД для объекта рекламирования.

fias_region_list

Уникальные идентификаторы ФИАС регионов показа. Если массив пустой, то регионом показа считается вся Россия.

is_social

Признак социальной рекламы.

is_native

Признак нативной рекламы.

Формат ответа

{
  "data": {
    "clid": {integer},
    "service": {string},
    "type": {string},
    "token": {string},
    "form": {string},
    "urls": [
      {string}
    ],
    "okveds": [
      {string}
    ],
    "text_data": [
      {string}
    ],
    "media_data": [
      {
        "media_url": {string},
        "description": {string}
      }
    ],
    "description": {string},
    "is_social": {boolean},
    "is_native": {boolean}
  },
  "result": {string}
}      

Параметры ответа

clid

CLID, для которого будет зарегистрирован креатив.

service

Сервис, для которого регистрируется креатив. Используется только если не удалось опредилить креатив из CLIDа. Например, для Яндекс Маркета должно быть значение market.

type

Тип рекламной кампании: cpa, cpc, cpm, other.

urls

Cписок целевых ссылок.

okveds

Список кодов ОКВЭД для объекта рекламирования.

fias_region_list

Уникальные идентификаторы ФИАС регионов показа. Если массив пустой, то регионом показа считается вся Россия.

is_social

Признак социальной рекламы.

is_native

Признак нативной рекламы.

Пример для JSON

Запрос:

{
  "clid": 123456,
  "form": "banner",
  "text_data": [
    "Test content"
  ],
  "media_data": [
    {
      "media_url": "https://ya.cc/123123",
      "description": "Test media data"
    }
  ],
  "description": "Test description"
}     
      

Ответ:

{
  "data": {
    "clid": 123456,
    "service": "market",
    "type": "other",
    "token": "4CQwVszL78Gt5cHA6pP",
    "form": "banner",
    "urls": [
      "https://market.yandex.ru/"
    ],
    "okveds": [
      "62.01"
    ],
    "text_data": [
      "Test content"
    ],
    "media_data": [
      {
        "media_url": "https://ya.cc/123123",
        "description": "Test media data"
      }
    ],
    "description": "Test description",
    "is_social": false,
    "is_native": false
  },
  "result": "ok"
}
      
Предыдущая