AdsApp.FrequencyCaps
Stay organized with collections Save and categorize content based on your preferences.
FrequencyCaps provides access to each of the frequency cap.
Methods:
getEntityType()
Returns the type of this entity as a
String, in this case,
"FrequencyCaps".
Return values:
| Type | Description |
|---|
String | Type of this entity: "FrequencyCaps". |
getFrequencyCapFor(eventType, timeUnit)
Get the frequency cap for the chosen event type and time unit.
Arguments:
| Name | Type | Description |
|---|
| eventType | String | The type of event that the cap applies to. |
| timeUnit | String | The unit of time that the cap applies to. If unspecified, the function returns the first frequency cap applied to the event type. |
Return values:
| Type | Description |
|---|
AdsApp.FrequencyCap | The corresponding frequency cap with the event type and time unit or null if one does not exist. |
newFrequencyCapBuilder()
Returns a new frequency cap builder for the campaign that the frequency caps belong to. When
FrequencyCapBuilder.build() is called, a frequency cap will be added in this campaign.
Return values:
removeFrequencyCapFor(eventType, timeUnit)
Remove the frequency cap for the chosen event type and time unit.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| eventType | String | The type of event that the cap applies to. The value can be either IMPRESSION or VIDEO_VIEW. |
| timeUnit | String | The unit of time that the cap applies to. If unspecified, the function removes all frequency caps applied to the event type. |
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 2025-06-04 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-04 UTC."],[[["`FrequencyCaps` allows access and management of frequency caps within Google Ads campaigns."],["You can retrieve, create, and remove frequency caps for specific event types (like impressions or video views) and time units (like day, week, or month)."],["The `FrequencyCapBuilder` helps create new frequency caps for a campaign, providing flexibility in setting limits."],["`getEntityType` identifies this entity as \"FrequencyCaps\" for programmatic access within scripts."]]],[]]