Get

Возвращает список изображений.

Ограничения

Ответ метода может содержать не более 10 000 изображений.

Общее количество изображений, отвечающих заданным критериям, указывается в результирующем параметре TotalObjectsCount. Если общее количество превышает 10 000, то для получения всех изображений необходимо организовать постраничную выборку с помощью параметров Limit и Offset.

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

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

{
   "method": "AdImage",
   "param": {
      /* AdImageRequest */
      "Action": (string),
      "SelectionCriteria": {
         /* AdImageSelectionCriteria */
         "Logins": [
            (string)
            ...
         ],
         "AdImageHashes": [
            (string)
            ...
         ],
         "Assigned": [
            (string)
            ...
         ],
         "Limit": (int),
         "Offset": (int)
      }
   }
}

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

Параметр Описание Требуется
Объект AdImageRequest
Action Выполняемая операция: Get. Да
SelectionCriteria Объект AdImageSelectionCriteria, содержащий критерии отбора изображений. Для агентств
Объект AdImageSelectionCriteria
Logins

Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию.

Для рекламодателей параметр игнорируется.

 Для агентств
AdImageHashes Массив, содержащий хэши изображений (не более 10 000). Нет
Assigned

Массив строк, содержащий фильтры для отбора изображений по признаку привязки к объявлениям:

  • если содержит строку 'Yes', отбираются привязанные изображения;
  • если содержит строку 'No', отбираются непривязанные изображения;
  • если содержит обе строки или пустой массив, фильтрация не используется, отбираются все изображения.
 Нет
Limit

Количество изображений в ответе. Максимальное допустимое значение — 10 000. Если не указано, используется ограничение 10 000.

Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных.

 Нет
Offset

Количество изображений, которое должно быть пропущено при выборке. Если не указано, подразумевается 0.

Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных.

 Нет
Примечание
  1. Для рекламодателей в случае пустой структуры SelectionCriteria будут получены все изображения (но не более 10 000).

  2. Если в структуре SelectionCriteria задано более одного критерия, будут получены изображения, отвечающие одновременно всем критериям. Например, если для агентства указаны параметры Logins и Assigned со строкой 'Yes', будут получены привязанные к баннерам изображения, принадлежащие указанным логинам.
Параметр Описание Требуется
Объект AdImageRequest
Action Выполняемая операция: Get. Да
SelectionCriteria Объект AdImageSelectionCriteria, содержащий критерии отбора изображений. Для агентств
Объект AdImageSelectionCriteria
Logins

Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию.

Для рекламодателей параметр игнорируется.

 Для агентств
AdImageHashes Массив, содержащий хэши изображений (не более 10 000). Нет
Assigned

Массив строк, содержащий фильтры для отбора изображений по признаку привязки к объявлениям:

  • если содержит строку 'Yes', отбираются привязанные изображения;
  • если содержит строку 'No', отбираются непривязанные изображения;
  • если содержит обе строки или пустой массив, фильтрация не используется, отбираются все изображения.
 Нет
Limit

Количество изображений в ответе. Максимальное допустимое значение — 10 000. Если не указано, используется ограничение 10 000.

Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных.

 Нет
Offset

Количество изображений, которое должно быть пропущено при выборке. Если не указано, подразумевается 0.

Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных.

 Нет
Примечание
  1. Для рекламодателей в случае пустой структуры SelectionCriteria будут получены все изображения (но не более 10 000).

  2. Если в структуре SelectionCriteria задано более одного критерия, будут получены изображения, отвечающие одновременно всем критериям. Например, если для агентства указаны параметры Logins и Assigned со строкой 'Yes', будут получены привязанные к баннерам изображения, принадлежащие указанным логинам.

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

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

{
   "data": {
      /* AdImageResponse */
      "AdImages": [
         {  /* AdImage */
            "Login": (string),
            "AdImageHash": (string),
            "AdImageURL": (string),
            "Name": (string),
            "Assigned": (string)
         }
         ...
      ],
      "TotalObjectsCount": (int)
   }
}

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

Параметр Описание
Объект AdImageResponse
AdImages Массив объектов AdImage, содержащих информацию об изображениях.
TotalObjectsCount Общее количество изображений, соответствующих заданным критериям (без учета параметра Limit).
Объект AdImage
Login Логин владельца изображения.
AdImageHash Хэш изображения.
AdImageURL Ссылка на загруженное изображение.
Name Наименование (описание) изображения.
Assigned Привязано ли изображение хотя бы к одному объявлению клиента — Yes/No.
Параметр Описание
Объект AdImageResponse
AdImages Массив объектов AdImage, содержащих информацию об изображениях.
TotalObjectsCount Общее количество изображений, соответствующих заданным критериям (без учета параметра Limit).
Объект AdImage
Login Логин владельца изображения.
AdImageHash Хэш изображения.
AdImageURL Ссылка на загруженное изображение.
Name Наименование (описание) изображения.
Assigned Привязано ли изображение хотя бы к одному объявлению клиента — Yes/No.

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

Python

{
   'Action': 'Get',
   'SelectionCriteria': {
      'Logins': ['agrom','larry'],
      'Assigned': ['Yes'],
      'Limit': 20,
      'Offset': 60
   }
}

PHP

array(
   'Action' => 'Get',
   'SelectionCriteria' => array(
      'Logins' => array('agrom','larry'),
      'Assigned' => array('Yes'),
      'Limit' => 20,
      'Offset' => 60
   )
)

Perl

{
   'Action' => 'Get',
   'SelectionCriteria' => {
      'Logins' => ['agrom','larry'],
      'Assigned' => ['Yes'],
      'Limit' => 20,
      'Offset' => 60
   }
}