Retrieving List of Video Ad Playback Methods


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


This API allows you to retrieve the list of all the video ad playback methods present in the PubMatic system.




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 Query Parameters


Parameter NameTypeRequiredDescription

Page number to be fetched in case of multiple pages.
Its default value is 1.


Maximum number of rows to be included in the response.
Its default value is 100.


Response Headers


Response Header NameType
Content-type application-json

Response Body


Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique identifier of the video ad playback method.
descriptionStringDescription of the video ad playback method.

Sample Response JSON

    "metaData": {
        "startIndex": 1,
        "request": {
            "pageSize": 100,
            "pageNumber": 1
        "totalRecords": 4,
        "endIndex": 4
    "items": [
            "id": 1,
            "description": "Auto-play sound on"
            "id": 2,
            "description": "Auto-play sound off"
            "id": 3,
            "description": "Click-to-play"
           "id": 4,
            "description": "Mouse-over"

Error Codes

Error codes specific to this API method.


Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found

⇧ Top

⇧ Top

Do you have feedback on this document? Let us know: email us.

Table of Contents