add

Создает объявления.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Тип объявления должен соответствовать типу группы объявлений, см. таблицу в разделе Тип объявления.

Не допускается добавление объявлений в архивную кампанию.

Не более 1000 объявлений в одном вызове метода.

Ограничение на количество объявлений в группе для рекламодателя можно получить с помощью метода Clients.get или AgencyClients.get (элемент ADS_TOTAL_PER_ADGROUP массива Restrictions).

Запрос

Структура запроса в формате JSON:

{
  "method": "add",
  "params": { /* params */
    "Ads": [{  /* AdAddItem */
      "AdGroupId": (long), /* required */ 
      "TextAd": {  /* TextAdAdd */
        "Title": (string), /* required */
        "Title2": (string),
        "Text": (string), /* required */
        "Href": (string),
        "Mobile": ( "YES" | "NO" ), /* required */
        "DisplayUrlPath": (string),
        "VCardId": (long),
        "AdImageHash": (string),
        "SitelinkSetId": (long),
        "AdExtensionIds": [(long), ... ],
        "VideoExtension": {  /* VideoExtensionAddItem */
          "CreativeId": (long)
        },
        "PriceExtension": {  /* PriceExtensionAddItem */
          "Price": (long), /* required */
          "OldPrice": (long),
          "PriceQualifier": ( "FROM" | "UP_TO" | "NONE" ), /* required */
          "PriceCurrency": ( "RUB" | "BYN" | "CHF" | "EUR" | "KZT" | "TRY" | "UAH" | "USD" ) /* required */
        },
        "TurboPageId": (long)
      },
      "DynamicTextAd": {  /* DynamicTextAdAdd */
        "VCardId": (long),
        "AdImageHash": (string),
        "SitelinkSetId": (long),
        "AdExtensionIds": [(long), ... ],
        "Text": (string) /* required */
      },
      "MobileAppAd": {  /* MobileAppAdAdd */
        "AdImageHash": (string),
        "Text": (string), /* required */
        "Title": (string), /* required */
        "TrackingUrl": (string),
        "Action": ( "DOWNLOAD" | "GET" | "INSTALL" | "MORE" | "OPEN" | "UPDATE" | "PLAY" | "BUY_AUTODETECT" ), /* required */
        "Features": [{  /* MobileAppAdFeatureItem */
          "Feature": ( "PRICE" | "ICON" | "CUSTOMER_RATING" | "RATINGS" ), /* required */
          "Enabled": ( "YES" | "NO" ) /* required */
        }, ... ],
        "AgeLabel": ( "AGE_0" | ... | "AGE_18" )
      },
      "TextImageAd": {  /* TextImageAdAdd */
        "AdImageHash": (string), /* required */
        "Href": (string), 
        "TurboPageId": (long)
      },
      "MobileAppImageAd": {  /* MobileAppImageAdAdd */
        "AdImageHash": (string), /* required */
        "TrackingUrl": (string)
      },
      "TextAdBuilderAd": {  /* TextAdBuilderAdAdd */
        "Creative": { /* AdBuilderAdAddItem */
          "CreativeId": (long) /* required */
        }, /* required */
        "Href": (string), 
        "TurboPageId": (long)
      },
      "MobileAppAdBuilderAd": {  /* MobileAppAdBuilderAdAdd */
        "Creative": { /* AdBuilderAdAddItem */
          "CreativeId": (long) /* required */
        }, /* required */
        "TrackingUrl": (string)
      },
      "CpmBannerAdBuilderAd": {  /* CpmBannerAdBuilderAdAdd */
        "Creative": { /* AdBuilderAdAddItem */
          "CreativeId": (long) /* required */
        }, /* required */      
        "Href": (string), 
        "TrackingPixels": { /* ArrayOfString */
          "Items": [(string), ... ] /* required */
        },
        "TurboPageId": (long)
      },
      "CpcVideoAdBuilderAd": {  /* CpcVideoAdBuilderAdAdd */
        "Creative": { /* AdBuilderAdAddItem */
          "CreativeId": (long) /* required */
        }, /* required */
        "Href": (string), 
        "TurboPageId": (long)
      }
    }, ... ] /* required */
  } 
}
Параметр Тип Описание Обязательный
Структура params (для JSON) / AddRequest (для SOAP)
Ads array of AdAddItem

Объявления, которые требуется добавить.

Да
Структура AdAddItem
AdGroupId long Идентификатор группы, в которую добавляется объявление. Да
TextAd TextAdAdd Параметры текстово-графического объявления. См. Тип объявления. Либо TextAd, либо MobileAppAd, либо DynamicTextAd, либо TextImageAd, либо MobileAppImageAd, либо TextAdBuilderAd, либо MobileAppAdBuilderAd, либо CpcVideoAdBuilderAd, либо CpmBannerAdBuilderAd
DynamicTextAd DynamicTextAdAdd Параметры динамического объявления.
MobileAppAd MobileAppAdAdd Параметры объявления для рекламы мобильных приложений.
TextImageAd TextImageAdAdd Параметры графического объявления, создаваемого на основе изображения (при добавлении в группу текстово-графических объявлений).
MobileAppImageAd MobileAppImageAdAdd Параметры графического объявления, создаваемого на основе изображения (при добавлении в группу для рекламы мобильных приложений).
TextAdBuilderAd TextAdBuilderAdAdd Параметры графического объявления, создаваемого на основе креатива (при добавлении в группу текстово-графических объявлений).
MobileAppAdBuilderAd MobileAppAdBuilderAdAdd Параметры графического объявления, создаваемого на основе креатива (при добавлении в группу для рекламы мобильных приложений).
CpmBannerAdBuilderAd CpmBannerAdBuilderAdAdd Параметры медийного объявления.
CpcVideoAdBuilderAd CpcVideoAdBuilderAdAdd Параметры видеообъявления (в кампании с типом «Текстово-графические объявления»).
Структура TextAdAdd
Title string

Заголовок 1.

Не более 35 символов без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Да
Title2 string

Заголовок 2.

Не более 30 символов без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Нет
Text string

Текст объявления.

Не более 81 символа без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

Да
Mobile YesNoEnum Признак того, что объявление является мобильным: YES или NO. См. раздел Мобильные объявления помощи Директа. Да
Href string

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Хотя бы один из параметров Href, TurboPageId или VCardId (могут присутствовать все)
TurboPageId long Идентификатор Турбо-страницы.
VCardId long Идентификатор виртуальной визитки. Визитка должна принадлежать той же кампании, что и объявление.
AdImageHash string

Хэш изображения.

Для текстово-графических объявлений подходят только изображения с типом REGULAR и WIDE, см. Тип изображения.
Нет
SitelinkSetId long Идентификатор набора быстрых ссылок. Допускается только при наличии параметра Href или TurboPageId. Нет
DisplayUrlPath string

Отображаемая ссылка. Допускается только при наличии параметра Href. Не более 20 символов. В случае использования шаблона символы # не учитываются в длине.

Может содержать буквы, цифры, символы -, №, /, %, #. Запрещены пробел, символ _, двойные символы --, //.

См. раздел Отображаемая ссылка помощи Директа.

Нет
AdExtensionIds array of long Идентификаторы расширений. Не более 50 элементов в массиве. Нет
VideoExtension VideoExtensionAddItem

Видеодополнение.

См. раздел Видеодополнения помощи Директа.

Нет
PriceExtension PriceExtensionAddItem Цена в объявлении. Нет
Структура VideoExtensionAddItem
CreativeId long

Идентификатор креатива.

Получить идентификатор креатива можно с помощью метода Creatives.get.

Да
Структура PriceExtensionAddItem
Price long

Цена товара или услуги, умноженная на 1 000  000. Целое число, кратное 10 000 (что соответствует цене с двумя знаками после запятой). Максимальное значение — 10 000 000 000 000 000.

Да
OldPrice long Старая цена товара или услуги, умноженная на 1 000  000. Целое число, кратное 10 000. Старая цена должна быть строго меньше цены. Нет
PriceQualifier PriceQualifierEnum

Текстовое пояснение к цене:

  • FROM — «от».
  • UP_TO — «до».
  • NONE — нет пояснения.
Да
PriceCurrency PriceCurrencyEnum Валюта, в которой указана цена. Да
Структура DynamicTextAdAdd
VCardId long Идентификатор виртуальной визитки. Визитка должна принадлежать той же кампании, что и объявление. Нет
AdImageHash string

Хэш изображения.

Для динамических объявлений подходят только изображения с типом REGULAR и WIDE, см. Тип изображения.

Нет
SitelinkSetId long Идентификатор набора быстрых ссылок. Нет
AdExtensionIds array of long Идентификаторы расширений. Не более 50 элементов в массиве. Нет
Text string

Текст объявления.

Не более 81 символа без учета «узких» плюс не более 15 «узких» символов. Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

Да
Структура MobileAppAdAdd
AdImageHash string

Хэш изображения.

Для рекламы мобильных приложений подходят только изображения с типом WIDE, см. Тип изображения.

Нет
Text string

Текст объявления.

Не более 75 символов с учетом «узких». Каждое слово не более 23 символов. В случае использования шаблона символы # не учитываются в длине.

Да
Title string

Заголовок.

Не более 33 символов с учетом «узких». Каждое слово не более 22 символов. В случае использования шаблона символы # не учитываются в длине.

Да
TrackingUrl string Трекинговая ссылка для отслеживания установок приложения. Не более 1024 символов. Должна содержать протокол и доменное имя. Нет
Action MobileAppAdActionEnum

Надпись на кнопке:

  • DOWNLOAD — «Загрузить»

  • GET — «Скачать»

  • INSTALL — «Установить»

  • MORE — «Подробнее»

  • OPEN — «Открыть»

  • UPDATE — «Обновить»

  • PLAY — «Играть»

  • BUY_AUTODETECT — надпись зависит о цены приложения: «Купить», если цена отлична от нуля, или «Бесплатно», если цена равна нулю.

Да
Features array of MobileAppAdFeatureItem Дополнения, которые требуется автоматически загружать из магазина приложений и отображать в объявлении. Нет
AgeLabel MobAppAgeLabelEnum Возрастное ограничение. Значение по умолчанию — AGE_18. Нет
Структура MobileAppAdFeatureItem
Feature MobileAppFeatureEnum

Тип дополнения:

  • PRICE — цена;
  • ICON — иконка;
  • CUSTOMER_RATING — рейтинг;
  • RATINGS — количество оценок (отображается, только если включено отображение рейтинга).

Если тип дополнения отсутствует в массиве Features, дополнение не отображается.

Да
Enabled YesNoEnum

Отображать ли дополнение в объявлении.

Примечание.
  • Если дополнение не удалось загрузить из магазина приложений, для него допустимо значение YES, однако это дополнение не отображается при показе объявления.
  • Количество оценок отображается только вместе с рейтингом: если для типа CUSTOMER_RATING задано NO, а для RATINGS — YES, количество оценок не отображается.
Да
Структура TextImageAdAdd
AdImageHash string

Хэш изображения.

Для графических объявлений подходят только изображения с типом FIXED_IMAGE, см. Тип изображения.

Да
Href string

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Хотя бы один из параметров Href и TurboPageId (могут присутствовать оба)
TurboPageId long Идентификатор Турбо-страницы.
Структура MobileAppImageAdAdd
AdImageHash string

Хэш изображения.

Для графических объявлений подходят только изображения с типом FIXED_IMAGE, см. Тип изображения.

Да
TrackingUrl string Трекинговая ссылка для отслеживания установок приложения. Не более 1024 символов. Должна содержать протокол и доменное имя. Нет
Структура TextAdBuilderAdAdd
Creative AdBuilderAdAddItem

Креатив, созданный в конструкторе креативов.

См. раздел Конструктор креативов для графических объявлений помощи Директа.

Да
Href string

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Хотя бы один из параметров Href и TurboPageId (могут присутствовать оба)
TurboPageId long Индентификатор Турбо-страницы.
Структура MobileAppAdBuilderAdAdd
Creative AdBuilderAdAddItem

Креатив, созданный в конструкторе креативов.

См. раздел Конструктор креативов для графических объявлений помощи Директа.

Да
TrackingUrl string Трекинговая ссылка для отслеживания установок приложения. Не более 1024 символов. Должна содержать протокол и доменное имя. Нет
Структура CpmBannerAdBuilderAdAdd
Creative AdBuilderAdAddItem

Креатив, загруженный в веб-интерфейсе или созданный в конструкторе креативов.

См. раздел Создание медийной кампании помощи Директа.

Да
Href string

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Хотя бы один из параметров Href и TurboPageId (могут присутствовать оба)
TurboPageId long Индентификатор Турбо-страницы.
TrackingPixels ArrayOfString Может содержать не более двух строк:
  • Пиксель Яндекс.Аудиторий — см. раздел Пиксель помощи Яндекс.Аудиторий.
  • Счетчик показов ADFOX. В счетчике показов обязательно должен быть макрос %random% или %aw_random%.

Длина каждой строки не более 1024 символов.

Нет
Структура CpcVideoAdBuilderAdAdd
Creative AdBuilderAdAddItem

Креатив, созданный в конструкторе креативов.

См. раздел Видеообъявления / Конструктор креативов помощи Директа.

Да
Href string

Ссылка на сайт рекламодателя. Не более 1024 символов. В случае использования шаблона символы # не учитываются в длине.

Должна содержать протокол и доменное имя. Может содержать подстановочные переменные.

Хотя бы один из параметров Href и TurboPageId (могут присутствовать оба)
TurboPageId long Идентификатор Турбо-страницы.
Структура AdBuilderAdAddItem
CreativeId long

Идентификатор креатива.

Получить идентификатор креатива можно с помощью метода Creatives.get.

Да
Примечание. «Узкими» считаются символы !,.;:"

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления объявлений.
Структура ActionResult
Id long Идентификатор созданного объявления. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.