GetLimits

Возвращает общее количество изображений, которое клиент может загрузить, а также количество изображений, уже загруженных или находящихся в очереди на загрузку.

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

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

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

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

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

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

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

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

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

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

Для агентств

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

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

{
   "data": {
      /* AdImageResponse */
      "AdImageLimits": [
         {  /* AdImageLimit */
            "Login": (string),
            "Capacity": (int),
            "Utilized": (int)
         }
         ...
      ]
   }
}

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

Параметр Описание
Объект AdImageResponse
AdImageLimits Массив объектов AdImageLimit.
Объект AdImageLimit
Login Логин клиента.
Capacity Общее количество изображений, которое клиент может загрузить.
Utilized Количество загруженных изображений плюс количество заданий на загрузку со статусом Pending.
Параметр Описание
Объект AdImageResponse
AdImageLimits Массив объектов AdImageLimit.
Объект AdImageLimit
Login Логин клиента.
Capacity Общее количество изображений, которое клиент может загрузить.
Utilized Количество загруженных изображений плюс количество заданий на загрузку со статусом Pending.

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

Python

{
   'Action': 'GetLimits',
   'SelectionCriteria': {
      'Logins': ['agrom','larry']
   }
}

PHP

array(
   'Action' => 'GetLimits',
   'SelectionCriteria' => array(
      'Logins' => array('agrom','larry')
   )
)

Perl

{
   'Action' => 'GetLimits',
   'SelectionCriteria' => {
      'Logins' => ['agrom','larry']
   }
}