Page tree



Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs

Overview

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

Request

         

URIhttp://{domainName}/common/videoPosition/{id}
HTTP MethodGET


Request Headers

                 

Header NameTypeValueRequiredDescription
AuthorizationStringBearer ${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 NameTypeRequiredDescription
idintegeryesID of the video ad position.


Response

Response Headers

           

Response Header NameType
Content-type application-json


Response Body

                  

Response Body ParameterTypeDescription
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 CodeError Description
CC03_004Resource not found


⇧ Top