- 1 Minute to read
Frequency Capping Targeting
- 1 Minute to read
This article describes resources that enable you to read and define frequency capping targeting.
Set a limit on how frequently an ad is displayed to a user within a specified time frame.
The Yahoo DSP supports FREQUENCY_CAPPING
targeting for lines serving display and video ads.
Endpoint
/traffic/lines/{id}/targeting
A
GET
request enables you to view frequency capping targets by the specified line.A
POST
request enables you to target frequency capping with the specified line.
Resources
The targeting
resource is defined by the following FREQUENCY_CAPPING
targeting type-specific fields:
Parameter | Parameter Type | Description | Data Type | Required |
---|---|---|---|---|
| path | Specifies the line ID. |
| Y |
| body | Specifies the frequency cap interval.
|
| N |
| body | Specifies the number of impressions all for the selected
|
| N |
| body | Specifies whether the ad is served to known or unknown users:
|
| N |
| body | Viewable Frequency ignores frequency limits until the impression is viewable.
|
| N |
| body | Specifies an array of targeting types to target. To implement frequency capping, To learn more, refer to Targeting Types. |
| Y |
Note
For a complete list of
targeting
resource fields, refer to Targeting Object.
Add/Update Frequency Cap Targeting
Add or update frequency capping controls for the specified line.
POST traffic/lines/{id}/targeting/
Parameters
The line ID is specified in the path of the URL. All other parameters are specified in the body of the application/json
payload.
Example Request URL
POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting/
Example Request Body
{
"frequencyCapPeriod": "MONTHLY",
"frequencyCapValue": 4,
"serveUnknownUser": true,
"types": [
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
}
]
}
Example Response
{
"response": {
"types": [
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
}
],
"frequencyCapPeriod": "MONTHLY",
"frequencyCapValue": 4,
"serveUnknownUser": true
},
"errors": null,
"timeStamp": "2019-10-20T04:04:25Z"
}