get
Возвращает статус обработки загруженных видео.
Запрос
Cтруктура запроса в формате JSON.
{
"method": "GetRequest",
"params" : { /* required */
"Page" : {
"Limit" : (long),
"Offset" : (long)
},
"SelectionCriteria" : { /* required */
"Ids" : [ (string) ] /* required */
},
"FieldNames" : [ ("Id"|"Status") ] /* required */
}
}
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Да |
SelectionCriteria | AdVideosSelectionCriteria | Критерий отбора видео. | Да |
FieldNames | array of AdVideosFieldEnum | Имена параметров видео, которые требуется получить. | Да |
Структура AdVideosSelectionCriteria | |||
Ids | array of string | Отбирать видео с указанными идентификаторами. От 1 до 10 элементов в массиве. | Да |
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Да |
SelectionCriteria | AdVideosSelectionCriteria | Критерий отбора видео. | Да |
FieldNames | array of AdVideosFieldEnum | Имена параметров видео, которые требуется получить. | Да |
Структура AdVideosSelectionCriteria | |||
Ids | array of string | Отбирать видео с указанными идентификаторами. От 1 до 10 элементов в массиве. | Да |
Ответ
Cтруктура ответа в формате JSON.
{
"method": "GetResponse",
"result" : { /* required */
"LimitedBy" : (long),
"AdVideos" : [{
"Id" : (string),
"Status" : ("READY"|"ERROR"|"CONVERTING"|"NEW")
}, ... ]
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
AdVideos | array of AdVideoGetItem | Видео. |
Структура AdVideoGetItem | ||
Id | string | Идентификационный номер видео. |
Status | StatusEnum | Статус конвертации видео. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
AdVideos | array of AdVideoGetItem | Видео. |
Структура AdVideoGetItem | ||
Id | string | Идентификационный номер видео. |
Status | StatusEnum | Статус конвертации видео. |