AI-generated Key Takeaways
-
Represents a frequency cap in Google Ads, limiting the number of times an ad is shown to a user.
-
Defines the cap based on event type (impression or video view), level (campaign, ad group, or creative), and time unit (day, week, or month).
-
Uses
getEventType(),getLevel(),getLimit(), andgetTimeUnit()to access frequency cap settings. -
getEntityType()method confirms the entity as "FrequencyCap".
Methods:
| Member | Type | Description |
|---|---|---|
| getEntityType() | String |
Returns the type of this entity as a String, in this case,
"FrequencyCap". |
| getEventType() | String |
Returns type of event that the cap applies to. |
| getLevel() | String |
Returns the level on which the cap is to be applied. |
| getLimit() | long |
Returns the cap number for the frequency cap. |
| getTimeUnit() | String |
Returns the unit of time the cap is defined at. |
getEntityType()
Returns the type of this entity as a String, in this case,
"FrequencyCap". Return values:
| Type | Description |
|---|---|
String |
Type of this entity: "FrequencyCap". |
getEventType()
Returns type of event that the cap applies to. Possible return values:
IMPRESSION, VIDEO_VIEW
Return values:
| Type | Description |
|---|---|
String |
The type of event that the cap applies to. |
getLevel()
Returns the level on which the cap is to be applied. Possible return
values:
CAMPAIGN, AD_GROUP, AD_GROUP_CREATIVE
Return values:
| Type | Description |
|---|---|
String |
The level on which the cap is to be applied. |
getLimit()
Returns the cap number for the frequency cap. Return values:
| Type | Description |
|---|---|
long |
The cap number for the frequency cap. |
getTimeUnit()
Returns the unit of time the cap is defined at. Possible return values:
DAY, WEEK, MONTH
Return values:
| Type | Description |
|---|---|
String |
The unit of time the cap is defined at. |