Retrieving Details of a Video Ad Position

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Jun 14, 2017
Version 4Show Document
  • View in full screen mode

Overview

This API allows you to retrieve the details of a specific video ad position from the PubMatic system.

Request

         

URI
http://{domainName}/common/videoPosition/{id}
HTTP Method
GET

Request Headers

                 

Header Name
Type
Value
Required
Description
Authorization
String
Bearer ${access_token}
Yes

Publisher Token to authenticate and authorize the user calling the Unified Ad Server API. Send the access token generated for authentication at the place of ${access_token} in the request.

 

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Path Parameters

               

Parameter Name
Type
Required
Description
id
integer
yes
ID of the video ad position.

Response

Response Headers

           

Response Header Name
Type
Content-type 
application-json

Response Body

                  

Response Body Parameter
Type
Description
idIntegerUnique identifier of the video ad position.
descriptionStringDescription of the video ad position.

Sample Response JSON

 

{

    "id": 1,

    "description": "Pre-roll"

}

Error Codes

Error codes specific to this API method.

           

Error Code
Error Description
CC03_004
Resource not found

Attachments

    Outcomes