Line Multi-Layer Frequency Capping Targeting¶

Set a limit on how frequently the platform shows an ad to a user within a specified time frame through reading and defining multi-layer frequency capping targeting.

Multi-layer frequency capping is not available for Yahoo Native lines.

The Yahoo DSP supports FREQUENCY_CAPPING targeting for lines serving display and video ads.

Endpoint¶

/traffic/lines/{id}/targeting

Use a GET request to view frequency capping targets by the specified line.
Use a POST request to target frequency capping with the specified line.

Resources¶

Define the targeting resource by the following FREQUENCY_CAPPING targeting type-specific fields:

Field	Description	Data Type	Create	Update
`hhFrequencyCapEnabled`	A value of false means the limit will be set by People/Device. A value of true means the limit will be set by Household. Limit the frequency capping by Household is only for CTV lines.	`boolean`	Required	Required

Line Frequency Cap Object¶

A Line Frequency Cap object defines multi-layer frequency capping for the line.

Use the lineFrequencyCap to set up to 3 layers of frequency capping.

Field	Description	Data Type	Create	Update
`lineId`	Specifies the line ID.	`integer`	Required	Required
`frequencyCapValueMinute`	Specifies the maximum number of impressions to serve per minute.	`integer`	Optional	Optional
`frequencyCapValueHour`	Specifies the maximum number of impressions to serve per hour.	`integer`	Optional	Optional
`frequencyCapPeriodMultiHour`	Specifies the line frequency capping period. Currently, supports 6 hours and 12 hours.	`integer`	Optional	Optional
`frequencyCapPeriodValueHour`	Specifies the maximum number of impressions to serve per 6 or 12 hours. This is mandatory when `frequencyCapPeriodMultiHour` is specified.	`integer`	Optional	Optional
`frequencyCapValueDay`	Specifies the maximum number of impressions to serve per day.	`integer`	Optional	Optional
`frequencyCapValueWeek`	Specifies the maximum number of impressions to serve per week.	`integer`	Optional	Optional
`frequencyCapValueMonth`	Specifies the maximum number of impressions to serve per month.	`integer`	Optional	Optional

Note

For a complete list of targeting resource fields, refer to Targeting Object.

Add/Update Multi-Layer Line Frequency Cap Targeting¶

Add or update frequency capping controls for the specified line.

POST traffic/lines/{id}/targeting/

Parameters¶

Specify the line ID is in the path of the URL. Specify all other parameters in the body of the application/json payload.

Sample Request URL¶

POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/{lineId}/targeting/

Sample Request Body¶

{
  "hhFrequencyCapEnabled”: false,
  "lineFrequencyCap": {
    "lineId": {lineId},
    "frequencyCapValueMinute": 0,
    "frequencyCapValueHour": 0,
    "frequencyCapPeriodMultiHour": 6,
    "frequencyCapValueMultiHour": 2,
    "frequencyCapValueDay": 0,
    "frequencyCapValueWeek": 10,
    "frequencyCapValueMonth": 20
  },
  "serveUnknownUser": true,
  "types": [
    {
      "name": "FREQUENCY_CAPPING",
      "isTargeted": true
    }
  ]
}

Sample Response¶

{
  "response": {
    "types": [
      {
        "name": "FREQUENCY_CAPPING",
        "isTargeted": true
      }
    ],
    "hhFrequencyCapEnabled”: false,
    "lineFrequencyCap": {
      "lineId": {lineId},
      "frequencyCapValueMinute": 0,
      "frequencyCapValueHour": 0,
      "frequencyCapPeriodMultiHour": 6,
      "frequencyCapValueMultiHour": 2,
      "frequencyCapValueDay": 0,
      "frequencyCapValueWeek": 10,
      "frequencyCapValueMonth": 20
    },
    "serveUnknownUser": true
  },
  "errors": null,
  "timeStamp": "2019-10-20T04:04:25Z"
}

Additional Resources¶

About Targeting