Creative Rotation API (UAS)

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

Description

The Creative Rotation API enables you to retrieve various rotations of Creatives supported by the Unified Ad Server.

For more information about UAS Creative Management Services, refer to Creative Management Services (UAS)

Supported Operations

                     

Method PathHTTP Method TypeDescriptionLink to Definition
/creativerotations/{id}GET

Retrieve the details of a specific creative rotation for the requested id.

Supported Rotation Types

                            
IDRotation TypeDescription
1Evenly

Creatives rotate evenly associated with the Line Item.

2Sequential

Creatives rotate sequentially for the user based on sequence number. The Line Item with a sequential rotation creative will only deliver for the user where PubMatic cookies are dropped successfully; otherwise, only the first creative will be shown for the cookie-less user.

Range can be specified from 1 to 100.

3Weighted

Creatives rotate at a frequency assigned to a Creative. The frequency will be calculated per the following:

Frequency for Creative = Total Weight for all Creatives associated Line Items/Weight for particular Creative

4OptimizedCreative with highest performance will get served.
Retrieve details of a Creative Rotation
/creativerotations/GET

Retrieve a list of all supported Creative Rotations.

You can apply supported dimensions, filters and sorting options to fetch a list of Tracking Events with a specific set of details.

Retrieve a list of Creative Rotations

 

Retrieve details of a Creative Rotation

 

Overview

This API enables you to retrieve the details of a specific Creative Rotation for the requested ID.

Supported Rotation Types

                            

IDRotation TypeDescription
1Evenly

Creatives rotate evenly associated with the Line Item.

2Sequential

Creatives rotate sequentially for the user based on sequence number. The Line Item with a sequential rotation creative will only deliver for the user where PubMatic cookies are dropped successfully; otherwise, only the first creative will be shown for the cookie-less user.

Range can be specified from 1 to 100.

3Weighted

Creatives rotate at a frequency assigned to a Creative. The frequency will be calculated per the following:

Frequency for Creative = Total Weight for all Creatives associated Line Items/Weight for particular Creative

4OptimizedCreative with highest performance will get served.
 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${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 URL

https://api.pubmatic.com/v1/uas/creativerotations/1 

 

Response

Sample Response JSON

    

{
    "id": 1,
    "name": "Evenly"
}

Retrieve a list of Creative Rotations

 

Overview

This API enables you to retrieve a list of Creative Rotationss. In the query, you can also apply supported dimensions, filters and sorting options to fetch a list of Tracking Events with a specific set of details according to your requirements.

 

Refer to Common Request Query Parameters to learn more about using dimensions, sort and filter options.

 

Request

           

Request Headers

                        

Header nameType ValueRequiredDescription
Content-TypeStringapplication/jsonYesMedia type for request.
pubTokenString${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 URL

https://api.pubmatic.com/v1/uas/creativerotations?dimensions=id,name&filters=id eq 1

Response

Sample Response JSON

    

Response will contain records associated with your account that match the request and filtering criteria.

Error Codes for Creative Rotation

Sr. No.Error CodesDescription
1MISSING_OR_INVALID_PARAMETERRequested details for a Creative Rotation with an id that does not exist or is invalid.

Attachments

    Outcomes