add

Выполняет синхронную загрузку изображений в виде бинарных данных.

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

Ограничения

Количество изображений у рекламодателя не может превышать 1000 + 2 × количество объявлений.

Не более 100 изображений в одном вызове метода. Рекомендуем загружать не более 3 изображений в одном вызове.

Если изображения идентичны, то будет создано только одно изображение.

Ограничения на размер изображения представлены в разделе Требования к изображениям, загружаемым через API.

Запрос

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

{
  "method": "add",
  "params": { /* params */
    "AdImages": [{  /* AdImageAddItem */
      "ImageData": (base64Binary), /* required */
      "Type" : ("REGULAR" | "WIDE" | "FIXED_IMAGE" | "AUTO" ),
      "Name": (string) /* required */
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
AdImages array of AdImageAddItem Изображения, которые требуется добавить (не более 100). Да
Структура AdImageAddItem
ImageData base64Binary

Загружаемое изображение: бинарные данные, закодированные в base64.

Примечание.

При использовании SOAP-библиотеки в это поле следует поместить непосредственно бинарные данные, а библиотека автоматически при передаче закодирует их в base64.

При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку.

Да
Type AdImageAddTypeEnum

Тип изображения. Cм. здесь.

Тип определется автоматически, если значение Type не указано или указано значение AUTO.

Если изображение подходит к двум типам, например, FIXED_IMAGE и REGULAR/WIDE, то будет выбран тип REGULAR/WIDE.

Нет
Name string Произвольное наименование изображения. Не более 255 символов. Да
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
AdImages array of AdImageAddItem Изображения, которые требуется добавить (не более 100). Да
Структура AdImageAddItem
ImageData base64Binary

Загружаемое изображение: бинарные данные, закодированные в base64.

Примечание.

При использовании SOAP-библиотеки в это поле следует поместить непосредственно бинарные данные, а библиотека автоматически при передаче закодирует их в base64.

При использовании формата JSON следует предварительно закодировать бинарные данные в base64 и передать их как строку.

Да
Type AdImageAddTypeEnum

Тип изображения. Cм. здесь.

Тип определется автоматически, если значение Type не указано или указано значение AUTO.

Если изображение подходит к двум типам, например, FIXED_IMAGE и REGULAR/WIDE, то будет выбран тип REGULAR/WIDE.

Нет
Name string Произвольное наименование изображения. Не более 255 символов. Да

Ответ

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

{
  "result": { /* result */
    "AddResults": [{  /* AdImageActionResult */
      "AdImageHash": (string),
      "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 AdImageActionResult Результаты добавления изображений.
Структура AdImageActionResult
AdImageHash string

Хэш изображения. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.

Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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

Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of AdImageActionResult Результаты добавления изображений.
Структура AdImageActionResult
AdImageHash string

Хэш изображения. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.

Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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

Пример

{
  "method": "add",
  "params": { 
    "AdImages": [{  
      "ImageData": "iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAA...", 
      "Name": "elephants.jpg" 
    }]
  }
}