CheckUploadStatus
Возвращает список заданий на загрузку изображений, созданных операцией Upload.
Задания (в том числе выполненные и завершившиеся ошибкой) сохраняются около суток.
Ограничения
Ответ метода может содержать не более 10 000 заданий на загрузку.
Общее количество заданий, отвечающих заданным критериям, указывается в результирующем параметре TotalObjectsCount. Если общее количество превышает 10 000, то для получения всех заданий необходимо организовать постраничную выборку с помощью параметров Limit и Offset.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "AdImage",
"param": {
/* AdImageRequest */
"Action": (string),
"SelectionCriteria": {
/* AdImageSelectionCriteria */
"Logins": [
(string)
...
],
"AdImageUploadTaskIDS": [
(int)
...
],
"Limit": (int),
"Offset": (int)
},
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект AdImageRequest | ||
---|---|---|
Action | Выполняемая операция: CheckUploadStatus. | Да |
SelectionCriteria | Объект AdImageSelectionCriteria, содержащий критерии отбора заданий, статус которых нужно получить. | Для агентств |
Объект AdImageSelectionCriteria | ||
Logins | Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию. Для рекламодателей параметр игнорируется. | Для агентств |
AdImageUploadTaskIDS | Массив, содержащий номера заданий на загрузку. | Нет |
Limit | Количество заданий в ответе. Максимальное допустимое значение — 10 000. Если не указано, используется ограничение 10 000. Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных. | Нет |
Offset | Количество заданий, которое должно быть пропущено при выборке. Если не указано, подразумевается 0. Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных. | Нет |
Примечание | ||
|
Параметр | Описание | Требуется |
Объект AdImageRequest | ||
---|---|---|
Action | Выполняемая операция: CheckUploadStatus. | Да |
SelectionCriteria | Объект AdImageSelectionCriteria, содержащий критерии отбора заданий, статус которых нужно получить. | Для агентств |
Объект AdImageSelectionCriteria | ||
Logins | Для агентств — массив, содержащий логины клиентов (не более 10), для которых нужно выполнить операцию. Для рекламодателей параметр игнорируется. | Для агентств |
AdImageUploadTaskIDS | Массив, содержащий номера заданий на загрузку. | Нет |
Limit | Количество заданий в ответе. Максимальное допустимое значение — 10 000. Если не указано, используется ограничение 10 000. Вместе с параметром Offset позволяет организовать постраничную выборку из базы данных. | Нет |
Offset | Количество заданий, которое должно быть пропущено при выборке. Если не указано, подразумевается 0. Вместе с параметром Limit позволяет организовать постраничную выборку из базы данных. | Нет |
Примечание | ||
|
Результирующие данные
Ниже показана структура результирующих данных в формате JSON.
{
"data": {
/* AdImageResponse */
"AdImageUploads": [
{ /* AdImage */
"Login": (string),
"AdImageUploadTaskID": (int),
"Status": (string),
"AdImageHash": (string),
"AdImageURL": (string),
"SourceURL": (string)
"Name": (string),
"Error": {
/* Error */
"FaultCode": (int),
"FaultString": (string),
"FaultDetail": (string)
}
}
...
],
"TotalObjectsCount": (int)
}
}
Ниже приведено описание параметров.
Параметр | Описание |
Объект AdImageResponse | |
---|---|
AdImageUploads | Массив объектов AdImageUpload, содержащих информацию о заданиях на загрузку. |
TotalObjectsCount | Общее количество заданий, соответствующих заданным критериям (без учета параметра Limit). |
Объект AdImageUpload | |
Login | Логин владельца изображения. |
AdImageUploadTaskID | Номер задания на загрузку изображения. |
Status | Статус загрузки изображения:
|
AdImageHash | Хэш изображения. Параметр возвращается, если изображение успешно загружено. |
AdImageURL | Ссылка на загруженное изображение. Параметр возвращается, если изображение успешно загружено. |
SourceURL | URL, с которого было загружено изображение. |
Name | Наименование (описание) изображения. |
Error | Объект Error — ошибка, возникшая при загрузке изображения. |
Объект Error | |
FaultCode | Код ошибки. |
FaultString | Текст сообщения об ошибке. |
FaultDetail | Подробное описание причины ошибки. |
Параметр | Описание |
Объект AdImageResponse | |
---|---|
AdImageUploads | Массив объектов AdImageUpload, содержащих информацию о заданиях на загрузку. |
TotalObjectsCount | Общее количество заданий, соответствующих заданным критериям (без учета параметра Limit). |
Объект AdImageUpload | |
Login | Логин владельца изображения. |
AdImageUploadTaskID | Номер задания на загрузку изображения. |
Status | Статус загрузки изображения:
|
AdImageHash | Хэш изображения. Параметр возвращается, если изображение успешно загружено. |
AdImageURL | Ссылка на загруженное изображение. Параметр возвращается, если изображение успешно загружено. |
SourceURL | URL, с которого было загружено изображение. |
Name | Наименование (описание) изображения. |
Error | Объект Error — ошибка, возникшая при загрузке изображения. |
Объект Error | |
FaultCode | Код ошибки. |
FaultString | Текст сообщения об ошибке. |
FaultDetail | Подробное описание причины ошибки. |
Примеры входных данных
Python
{
'Action': 'CheckUploadStatus',
'SelectionCriteria': {
'Logins': ['agrom','larry'],
'AdImageUploadTaskIDS': [571703,571705,571707],
'Limit': 20,
'Offset': 60
}
}
PHP
array(
'Action' => 'CheckUploadStatus',
'SelectionCriteria' => array(
'Logins' => array('agrom','larry'),
'AdImageUploadTaskIDS' => array(571703,571705,571707),
'Limit' => 20,
'Offset' => 60
)
)
Perl
{
'Action' => 'CheckUploadStatus',
'SelectionCriteria' => {
'Logins' => ['agrom','larry'],
'AdImageUploadTaskIDS' => [571703,571705,571707],
'Limit' => 20,
'Offset' => 60
}
}