Retrieving List of Video Ad Playback Methods

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 list of all the video ad playback methods present in the PubMatic system.

Request

         

URI
http://{domainName}/common/videoPlayback?pageSize=20&pageNumber=1
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 Query Parameters

                     

Parameter Name
Type
Required
Description
pageNumber
Integer
Optional
Page number to be fetched in case of multiple pages.
Its default value is 1.
pageSize
Integer
Optional
Maximum number of rows to be included in the response.
Its default value is 100.

Response

Response Headers

           

Response Header Name
Type
Content-type 
application-json

Response Body

                       

Response Body Parameter
Type
Description
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 Code
Error Description
CC03_0001
No records found
CC03_0004
Resource not found

Attachments

    Outcomes