Frequency Cap¶

You can define the number of times users can be exposed to your campaign in a given time period. Note that this only applies to PROMOTE_BRAND campaigns. For other campaign types, the frequency is managed and optimized by the Native Ad Platform API.

Endpoint¶

Resource URI

https://api.gemini.yahoo.com/v3/rest/frequency

You can set frequency capping by making a POST call passing in the following fields:

Name	Description	Type	Add	Update
`id`	The unique identifier	long	NA	Required
`value`	The number of times a given user will be exposed to your campaign.	int	Required	Optional
`type`	The time interval for which the frequency cap is set. Currently this must be set to DAILY or WEEKLY.	enum	Required	Optional (Read-Only)
`advertiserId`	The advertiser id.	long	Required	Optional (Read-Only)
`parentType`	Must be set to CAMPAIGN.	enum	Required	Optional (Read-Only)
`parentId`	The ID of the parent campaign.	long	Required	Optional (Read-Only)
`status`	Valid values are ACTIVE, PAUSED and DELETED. Will default to ACTIVE if not provided.	enum	Optional	Optional

For example, to set frequency capping for a campaign:

PUT https://api.gemini.yahoo.com/v3/rest/frequency

Data passed
{
  "value": 10,
  "type": "DAILY",
  "advertiserId": 11610,
  "parentType": "CAMPAIGN",
  "parentId": 332817035,
  "id": 299239189394
}


Example response
{
  "errors": null,
  "timestamp": "2015-08-22 1:58:45",
  "response": {
      "type": "DAILY",
      "id": 295617989759,
      "status": "ACTIVE",
      "parentId": 332817035,
      "parentType": "CAMPAIGN",
      "advertiserId": 11610,
      "value": "10"
  }
}

To delete frequency capping for a campaign:

PUT https://api.gemini.yahoo.com/v3/rest/frequency

Data passed
{
  "id": 295617989759,
  "status": "DELETED"
}


Example response
{
  "errors": null,
  "timestamp": "2015-08-22 2:08:50",
  "response": {
      "type": "DAILY",
      "status": "DELETED",
      "id": 295617989759,
      "parentId": 332817035,
      "parentType": "CAMPAIGN",
      "advertiserId": 11610,
      "value": "10"
  }
}