get
Returns the processing status of uploaded videos.
Request
Request structure in JSON format.
{
"method": "GetRequest",
"params" : { /* required */
"Page" : {
"Limit" : (long),
"Offset" : (long)
},
"SelectionCriteria" : { /* required */
"Ids" : [ (string) ] /* required */
},
"FieldNames" : [ ("Id"|"Status") ] /* required */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
Page | LimitOffset | Structure that defines the page for paginated selection of data. | Yes |
SelectionCriteria | AdVideosSelectionCriteria | Criteria for selecting videos. | Yes |
FieldNames | array of AdVideosFieldEnum | Names of video parameters to get. | Yes |
AdVideosSelectionCriteria structure | |||
Ids | array of string | Select videos with the specified IDs. From 1 to 10 items in the array. | Yes |
Parameter | Type | Description | Required |
Params structure (for JSON) / GetRequest (for SOAP) | |||
---|---|---|---|
Page | LimitOffset | Structure that defines the page for paginated selection of data. | Yes |
SelectionCriteria | AdVideosSelectionCriteria | Criteria for selecting videos. | Yes |
FieldNames | array of AdVideosFieldEnum | Names of video parameters to get. | Yes |
AdVideosSelectionCriteria structure | |||
Ids | array of string | Select videos with the specified IDs. From 1 to 10 items in the array. | Yes |
Response
Response structure in JSON format.
{
"method": "GetResponse",
"result" : { /* required */
"LimitedBy" : (long),
"AdVideos" : [{
"Id" : (string),
"Status" : ("READY"|"ERROR"|"CONVERTING"|"NEW")
}, ... ]
}
}
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
LimitedBy | long | Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection. |
AdVideos | array of AdVideoGetItem | Video. |
AdVideoGetItem structure | ||
Id | string | ID of the video. |
Status | StatusEnum | Video conversion status. |
Parameter | Type | Description |
Result structure (for JSON) / GetResponse (for SOAP) | ||
---|---|---|
LimitedBy | long | Sequential number of the last object returned. It is included if there was a limit on the number of objects in the response. See the section Paginated data selection. |
AdVideos | array of AdVideoGetItem | Video. |
AdVideoGetItem structure | ||
Id | string | ID of the video. |
Status | StatusEnum | Video conversion status. |