Line Multi-Layer Frequency Capping Targeting¶
This article describes resources you can use to read and define multi-layer frequency capping targeting.
Overview¶
Set a limit on how frequently the platform shows an ad to a user within a specified time frame.
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:
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 |
---|---|---|---|---|
|
Specifies the line frequency cap ID. |
|
N/A |
Required |
|
Specifies the line ID. |
|
Required |
Required |
|
Specifies the maximum number of impressions to serve per minute. |
|
Optional |
Optional |
|
Specifies the maximum number of impressions to serve per hour. |
|
Optional |
Optional |
|
Specifies the line frequency capping period. Currently, supports 6 hours and 12 hours. |
|
Optional |
Optional |
|
Specifies the maximum number of impressions to serve per 6 or 12 hours. This is mandatory when |
|
Optional |
Optional |
|
Specifies the maximum number of impressions to serve per day. |
|
Optional |
Optional |
|
Specifies the maximum number of impressions to serve per week. |
|
Optional |
Optional |
|
Specifies the maximum number of impressions to serve per month. |
|
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.
Example Request URL¶
POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting/
Example Request Body¶
{
"lineFrequencyCap": {
"lineFrequencyCapId": 101,
"lineId": 365277,
"frequencyCapValueMinute": 0,
"frequencyCapValueHour": 0,
"frequencyCapPeriodMultiHour": 6,
"frequencyCapValueMultiHour": 2,
"frequencyCapValueDay": 0,
"frequencyCapValueWeek": 10,
"frequencyCapValueMonth": 20
},
"serveUnknownUser": true,
"types": [
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
}
]
}
Example Response¶
{
"response": {
"types": [
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
}
],
"lineFrequencyCap": {
"lineFrequencyCapId": 101,
"lineId": 365277,
"frequencyCapValueMinute": 0,
"frequencyCapValueHour": 0,
"frequencyCapPeriodMultiHour": 6,
"frequencyCapValueMultiHour": 2,
"frequencyCapValueDay": 0,
"frequencyCapValueWeek": 10,
"frequencyCapValueMonth": 20
},
"serveUnknownUser": true
},
"errors": null,
"timeStamp": "2019-10-20T04:04:25Z"
}