AdsApp.FrequencyCapBuilder
Stay organized with collections Save and categorize content based on your preferences.
Builder for
FrequencyCap objects.
Methods:
build()
Builds the frequency cap.
Returns nothing.
withEventType(eventType)
Set the event type to the new frequency cap.
Arguments:
| Name | Type | Description |
|---|
| eventType | String | The type of event that the cap applies to. The value can be either IMPRESSION or VIDEO_VIEW. |
Return values:
withLimit(limit)
Set the cap number to the new frequency cap.
Arguments:
| Name | Type | Description |
|---|
| limit | long | Number of time units the cap lasts. |
Return values:
withTimeUnit(timeUnit)
Set the time unit to the new frequency cap.
Arguments:
| Name | Type | Description |
|---|
| timeUnit | String | Unit of time the cap is defined at. The value can be DAY, WEEK or MONTH. |
Return values:
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."],[[["This page documents the `FrequencyCap` builder, which is used to create frequency caps in Google Ads scripts."],["The builder provides methods to set the event type (`IMPRESSION` or `VIDEO_VIEW`), the frequency limit, and the time unit (`DAY`, `WEEK`, or `MONTH`)."],["`build()` method is used to finalize and create the frequency cap object."],["You can chain the `withEventType`, `withLimit`, and `withTimeUnit` methods to configure the frequency cap before building it."]]],[]]