Frequency Capping Targeting¶
Overview¶
Set a limit on how frequently an ad is shown to a user within a specified time frame.
The Verizon Media 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¶
This resource comprises multiple fields that enable you to specify line targeting across many types of targets including the EXCHANGES
target type.
The targeting
resource is defined by the following FREQUENCY_CAPPING
targeting type-specific fields:
The targeting
resource is defined by the following FREQUENCY_CAPPING
targeting type-specific fields:
Field | Description | Data Type |
---|---|---|
id |
Specifies the line ID. | integer |
threshold |
Specifies the acceptable in-target audience composition percentage for video ads. The value indicates the percentage of impressions that reach the intended demographic.
Note: This field is valid when campaign targeting verification vendor is not Yahoo. |
integer |
frequencyCapPeriod |
Specifies the frequency cap interval.
|
string |
frequencyCapValue |
Specifies the number of imporessions all for the selected
|
string |
serveUnknownUser |
Specifies whether the ad is served to known or unknown users:
|
boolean |
Note
For a complete list of targeting
resource fields, see Targeting Object.
Read Frequency Capping¶
Returns a list of targets for the specified line.
GET /traffic/lines/{id}/targeting
The resource returns information about all of the target types enabled and all of the targets specified for the line including genders
and ages
.
To learn more, see Read Line Targeting.
Add/Update Frequency Caps¶
Adds or updates 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.
Parameter | Parameter Type | Description | Data Type | Required? |
---|---|---|---|---|
id |
path | Specifies the line ID. | integer |
Y |
threshold |
body | Specifies the acceptable in-target audience composition percentage for video ads. The value indicates the percentage of impressions that reach the intended demographic.
Note: This field is valid when campaign targeting verification vendor is not Yahoo. |
integer |
N |
frequencyCapPeriod |
body | Specifies the frequency cap interval.
|
string |
N |
frequencyCapValue |
body | Specifies the number of imporessions all for the selected
|
string |
N |
serveUnknownUser |
body | Specifies whether the ad is served to known or unknown users:
|
boolean |
N |
types |
body | Specifies an array of targeting types to target. To implement frequency capping, To learn more, see Targeting Types. |
array |
Y |
Example Request¶
The line ID is specified in the path of the resource endpoint:
POST traffic/lines/365277/targeting/
All other parameters are specified in the body of the application/json payload.
{
"frequencyCapPeriod": "MONTHLY",
"frequencyCapValue": 4,
"serveUnknownUser": true,
"types": [
{
"name": "FREQUENCY_CAPPING",
"isTargeted": true
}
]
}
See also