AdsApp.FrequencyCap
Stay organized with collections
Save and categorize content based on your preferences.
Represents a Google Ads frequency cap. Methods:
getEntityType()
Returns the type of this entity as a String
, in this case, "FrequencyCap"
. Return values:
getEventType()
Returns type of event that the cap applies to. Possible return values: IMPRESSION, VIDEO_VIEW
Return values:
getLevel()
Returns the level on which the cap is to be applied. Possible return
values: CAMPAIGN, AD_GROUP, AD_GROUP_CREATIVE
Return values:
getLimit()
Returns the cap number for the frequency cap. Return values:
getTimeUnit()
Returns the unit of time the cap is defined at. Possible return values: DAY, WEEK, 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-09-03 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-09-03 UTC."],[[["\u003cp\u003eRepresents a frequency cap in Google Ads, limiting the number of times an ad is shown to a user.\u003c/p\u003e\n"],["\u003cp\u003eDefines the cap based on event type (impression or video view), level (campaign, ad group, or creative), and time unit (day, week, or month).\u003c/p\u003e\n"],["\u003cp\u003eUses \u003ccode\u003egetEventType()\u003c/code\u003e, \u003ccode\u003egetLevel()\u003c/code\u003e, \u003ccode\u003egetLimit()\u003c/code\u003e, and \u003ccode\u003egetTimeUnit()\u003c/code\u003e to access frequency cap settings.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetEntityType()\u003c/code\u003e method confirms the entity as "FrequencyCap".\u003c/p\u003e\n"]]],[],null,["# AdsApp.FrequencyCap\n\nRepresents a Google Ads frequency cap.\n\n### Methods:\n\n| Member | Type | Description |\n|-----------------------------------|----------|--------------------------------------------------------------------------------|\n| [getEntityType()](#getEntityType) | `String` | Returns the type of this entity as a `String`, in this case, `\"FrequencyCap\"`. |\n| [getEventType()](#getEventType) | `String` | Returns type of event that the cap applies to. |\n| [getLevel()](#getLevel) | `String` | Returns the level on which the cap is to be applied. |\n| [getLimit()](#getLimit) | `long` | Returns the cap number for the frequency cap. |\n| [getTimeUnit()](#getTimeUnit) | `String` | Returns the unit of time the cap is defined at. |\n\n`getEntityType()`\n-----------------\n\nReturns the type of this entity as a `String`, in this case, `\"FrequencyCap\"`.\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------------|\n| `String` | Type of this entity: `\"FrequencyCap\"`. |\n\n`getEventType()`\n----------------\n\nReturns type of event that the cap applies to. Possible return values:\n\n`IMPRESSION, VIDEO_VIEW`\n\n### Return values:\n\n| Type | Description |\n|----------|--------------------------------------------|\n| `String` | The type of event that the cap applies to. |\n\n`getLevel()`\n------------\n\nReturns the level on which the cap is to be applied. Possible return values:\n\n`CAMPAIGN, AD_GROUP, AD_GROUP_CREATIVE`\n\n### Return values:\n\n| Type | Description |\n|----------|----------------------------------------------|\n| `String` | The level on which the cap is to be applied. |\n\n`getLimit()`\n------------\n\nReturns the cap number for the frequency cap.\n\n### Return values:\n\n| Type | Description |\n|--------|---------------------------------------|\n| `long` | The cap number for the frequency cap. |\n\n`getTimeUnit()`\n---------------\n\nReturns the unit of time the cap is defined at. Possible return values:\n\n`DAY, WEEK, MONTH`\n\n### Return values:\n\n| Type | Description |\n|----------|-----------------------------------------|\n| `String` | The unit of time the cap is defined at. |"]]
