Set

Добавляет/удаляет привязки изображений к объявлениям.

Чтобы удалить привязку (отвязать изображение от объявления), необходимо передать структуру AdImageAssociation, в которой параметр AdImageHash отсутствует или равен NULL.

К объявлению может быть привязано только одно изображение: при добавлении новой привязки старая автоматически удаляется (баллы при этом списываются только за добавление).

Ограничения

Внимание. Метод поддерживает только текстово-графические объявления. Для работы с объявлениями всех типов используйте сервис Ads API версии 5. Подробнее о типах объявлений...

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

Ниже показана структура входных данных в формате JSON.

{
   "method": "AdImageAssociation",
   "param": {
      /* AdImageAssociationRequest */
      "Action": (string),
      "AdImageAssociations": [
         {  /* AdImageAssociation */
            "AdID": (long),
            "AdImageHash": (string),
         }
         ...
      ]
   }
}

Ниже приведено описание параметров.

Параметр Описание Требуется
Объект AdImageAssociationRequest
Action Выполняемая операция: Set. Да
AdImageAssociations Массив объектов AdImageAssociation (не более 10 000). Каждый объект сдержит привязку изображения к объявлению. Да
Объект AdImageAssociation
AdID Идентификатор объявления. Да
AdImageHash

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

Если параметр отсутствует или равен NULL, привязка изображения к объявлению удаляется.

Нет

Результирующие данные

Внимание. Ошибка при создании при добавлении/удалении одной из привязок не влечет отмену всей операции и не влияет на успешность добавления/удаления остальных привязок.

Ниже показана структура результирующих данных в формате JSON.

{
   "data": {
      /* AdImageAssociationResponse */
      "ActionsResult": [
         {  /* AdImageAssociationActionResult */
            "AdID": (long),
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ]
         }
         ...
      ],
   }
}

Ниже приведено описание параметров.

Параметр Описание
Объект AdImageAssociationResponse
ActionsResult

Массив объектов AdImageAssociationActionResult. Каждый объект соответствует элементу входного массива AdImageAssociations и содержит:

  • в случае успешного добавления/удаления привязки — только идентификатор объявления;
  • в случае ошибки — массив Errors.

Элементы массива следуют в том же порядке, что и объекты входного массива AdImageAssociations.

Объект AdImageAssociationActionResult
AdID Идентификатор объявления.
Errors Массив объектов Error — ошибок, возникших при добавлении/удалении привязки.
Объект Error
FaultCode Код ошибки.
FaultString Текст сообщения об ошибке.
FaultDetail Подробное описание причины ошибки.

Примеры входных данных

Python

{
   'Action': 'Set',
   'AdImageAssociations': [
      {
         # Добавление привязки
         'AdID': 2571700,
         'AdImageHash': 'c6da811f75221196dd5b1a8ca703344b',
      },
      {
         # Удаление привязки
         'AdID': 2571745
      },

   ]
}

PHP

array(
   'Action' => 'Set',
   'AdImageAssociations' => array(
      array(
         # Добавление привязки
         'AdID' => 2571700,
         'AdImageHash' => 'c6da811f75221196dd5b1a8ca703344b'
      ),
      array(
         # Удаление привязки
         'AdID' => 2571745
      )
   )
)

Perl

{
   'Action' => 'Set',
   'AdImageAssociations' => [
      {
         # Добавление привязки
         'AdID' => 2571700,
         'AdImageHash' => 'c6da811f75221196dd5b1a8ca703344b'
      },
      {
         # Удаление привязки
         'AdID' => 2571745
      }
   ]
}