media APIv1_beta.1.0

getVideo

GET
/video/{video_id}
This method retrieves a video's metadata and content given a specified video ID. The method returns the title, size, classification, description, video ID, playList, status, status message (if any), expiration date, and thumbnail image of the retrieved video.

The video’s title, size, classification, and description are set using the createVideo method.

The video's playList contains two URLs that link to instances of the streaming video based on the supported protocol.

The status field contains the current status of the video. After a video upload is successfully completed, the video's status will show as PROCESSING until the video reaches one of the terminal states of LIVE, BLOCKED or PROCESSING_FAILED.

If a video's processing fails, it could be because the file is corrupted, is too large, or its size doesn’t match what was provided in the metadata. Refer to the error messages to determine the cause of the video’s failure to upload.

The status message will indicate why a video was blocked from uploading.

The video’s expiration date is automatically set to 365 days (one year) after the video’s initial creation.

The video's thumbnail image is automatically generated when the video is created.

Input

Resource URI (production)

GET https://apim.ebay.com/commerce/media/v1_beta/video/{video_id}

URI parameters

ParameterTypeDescription
video_idstringThe video ID for the video to be retrieved.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.inventory

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
classificationarray of ClassificationThe intended use for this video content. The video’s classification is used to associate the video with a user or seller. Currently, the classification of all videos should be set to ITEM.

Occurrence: Always

descriptionstringThe description of the video. The video description is an optional field that can be set using the createVideo method.

Occurrence: Conditional

expirationDatestringThe expiration date of the video in Coordinated Universal Time (UTC). The video’s expiration date is automatically set to 365 days (one year) after the video’s initial upload.

Occurrence: Conditional

moderationModerationThe video moderation information that is returned if a video is blocked by moderators.

Tip: See Video moderation and restrictions in the eBay Seller Center for details about video moderation.

If the video status is BLOCKED, ensure that the video complies with eBay's video formatting and content guidelines. Afterwards, begin the video creation and upload procedure anew using the createVideo and uploadVideo methods.

Occurrence: Conditional

moderation.rejectReasonsarray of RejectReasonEnumThe reason(s) why the specified video was blocked by moderators.

Occurrence: Conditional

playListsarray of PlayThe playlist created for the uploaded video, which provides the streaming video URLs to play the video. The supported streaming video protocols are DASH (Dynamic Adaptive Streaming over HTTP) and HLS (HTTP Live Streaming). The playlist will only be generated if a video is successfully uploaded with a status of LIVE.

Occurrence: Conditional

playLists.playUrlstringThe playable URL for this video.

Occurrence: Conditional

playLists.protocolProtocolEnumThe protocol for the video playlist. Supported protocols are DASH (Dynamic Adaptive Streaming over HTTP) and HLS (HTTP Live Streaming).

Occurrence: Conditional

sizeintegerThe size, in bytes, of the video content.

Occurrence: Always

statusVideoStatusEnumThe status of the current video resource.

Occurrence: Conditional

statusMessagestringThe statusMessage field contains additional information on the status. For example, information on why processing might have failed or if the video was blocked.

Occurrence: Conditional

thumbnailImageThe URL of the thumbnail image of the video. The thumbnail image's URL must be an eBayPictureURL (EPS URL).

Occurrence: Conditional

thumbnail.imageUrlstringThe URL to access this image.

Occurrence: Conditional

titlestringThe title of the video.

Occurrence: Always

videoIdstringThe unique ID of the video.

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
403Forbidden
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
190000API_MEDIAAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
190001API_MEDIAREQUESTThe specified video_Id does not exist.
190013API_MEDIAREQUESTUnauthorized access.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get Video Details

This sample retrieves the details of a video, including the title, size, classification, description, video ID, playList, status, status message (if any), expiration date, and thumbnail image.

Input

The input is video_id. There is no payload with this request.
GET
https://apim.ebay.com/commerce/media/v1_beta/video/f******************************a

Output

If the call is successful, details of the video will be retrieved.