Создание и редактирования креативов

Описание

POST /marking

Создаёт новый или редактирует существующий креатив.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/marking
  • Не передавайте параметры is_social и is_native
  • Используйте параметры со значениями:
    • service — market;
    • type — cpa;
    • urls — список всех ссылок, которые вы используете в креативе;
    • okveds — 62.01.

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

Входные данные

Параметр

Тип

Значение

Обязательные

clid

Int64

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

form

String

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

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

text_data

String

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

media_data

Array

Список медиа в рекламном блоке. Из text_data и media_data достаточно заполнить только одно из полей.

media_url

String

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

media_url_file_type

String

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

  • image — изображение;
  • video — видео.

description

String

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

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

service

String

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

type

String

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

token

String

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

urls

Array

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

okveds

Array

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

fias_region_list

Array

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

is_social

Boolean

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

is_native

Boolean

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

Выходные данные

{
"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

Int64

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

service

String

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

type

String

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

urls

Array

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

okveds

Array

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

fias_region_list

Array

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

is_social

Boolean

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

is_native

Boolean

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

Примеры

Запрос:

{
  "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"
}