Frequency Cap Period 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

Use the Frequency Cap Period to retrieve the supported periods. This metadata will be required when setting the Frequency Cap on an Ad Unit, Order, Line Item or Creative in the Unified Ad Server.

Supported Operations

Service Name: /frequencycapperiods/

                     

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

Retrieve the details of a specific Frequency Cap Value for a requested id.

The Following Frequency Periods are supported:

                                 
IDFrequency PeriodComment
1MinuteTo set the number Frequency Cap Value per Minute
2HourTo set the number Frequency Cap Value per Hour
3Day
To set the number Frequency Cap Value per Day
4Week
To set the number Frequency Cap Value per Week
5LifeTime
To set the number Frequency Cap Value per LifeTime
Retrieve the Details of a Frequency Cap Period
/frequencycapperiods/GET

Retrieve a list of all Frequency Cap Period supported in the Unified Ad Server.

You can apply supported dimensions, filters and sorting options by macro service to retrieve a list of macros with a specific set of details as needed.

Retrieve a List of Frequency Cap Periods

 

Retrieve the Details of a Frequency Cap Period

Overview

This API retrieves the details of the specified Frequency Cap Period.

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.

 

Sample Request URL

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

Response

                  

Parameter NameTypeDescription
idNumericFrequency Cap Period Identifier
nameStringFrequency Cap Period Name

Sample Response JSON

    

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

 

Retrieve a List of Frequency Cap Periods

Overview

This API retrieves a list of supported Frequency Cap Periods.

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.

 

Sample Request URL

https://api.pubmatic.com/v1/uas/frequencycapperiods/ 

Response

                  

Parameter NameTypeDescription
idNumericFrequency Cap Period Identifier
nameStringFrequency Cap Period Name

Sample Response 

    

It will return a list of Frequency Cap Periods supported by the Unified Ad Server.

 

Error Codes for Frequency Cap Period

             

Sr. NoError CodesDescription
1MISSING_OR_INVALID_PARAMETERDetails were requested for a Frequency Cap Period with an Id that does not exist or is invalid.

 

Unified Ad Server References

Common Request Query Parameters for Web Services

Supported Operations for Filters

HTTP Status Codes

Unified Ad Server Specific Error Codes

 

 

Version 0.1

Attachments

    Outcomes