Display & Video 360 API v2 will sunset on
September 3, 2024.
Migrate to v3 before then to avoid an interruption of service.
FrequencyCap
Stay organized with collections
Save and categorize content based on your preferences.
Settings that control the number of times a user may be shown with the same ad during a given time period.
JSON representation |
{
"unlimited": boolean,
"timeUnit": enum (TimeUnit ),
"timeUnitCount": integer,
"maxImpressions": integer
} |
Fields |
unlimited |
boolean
Whether unlimited frequency capping is applied. When this field is set to true , the remaining frequency cap fields are not applicable.
|
timeUnit |
enum (TimeUnit )
The time unit in which the frequency cap will be applied. Required when unlimited is false .
|
timeUnitCount |
integer
The number of timeUnit the frequency cap will last. Required when unlimited is false . The following restrictions apply based on the value of timeUnit :
TIME_UNIT_LIFETIME - this field is output only and will default to 1
TIME_UNIT_MONTHS - must be between 1 and 2
TIME_UNIT_WEEKS - must be between 1 and 4
TIME_UNIT_DAYS - must be between 1 and 6
TIME_UNIT_HOURS - must be between 1 and 23
TIME_UNIT_MINUTES - must be between 1 and 59
|
maxImpressions |
integer
The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is false .
|
TimeUnit
Enums |
TIME_UNIT_UNSPECIFIED |
Time unit value is not specified or is unknown in this version. |
TIME_UNIT_LIFETIME |
The frequency cap will be applied to the whole life time of the line item. |
TIME_UNIT_MONTHS |
The frequency cap will be applied to a number of months. |
TIME_UNIT_WEEKS |
The frequency cap will be applied to a number of weeks. |
TIME_UNIT_DAYS |
The frequency cap will be applied to a number of days. |
TIME_UNIT_HOURS |
The frequency cap will be applied to a number of hours. |
TIME_UNIT_MINUTES |
The frequency cap will be applied to a number of minutes. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-09-14 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{
"last_modified": "Last updated 2023-09-14 UTC.",
"state": ""
}