AdsApp.​FrequencyCap

  • A Google Ads frequency cap represents a limit on how often an ad can be shown to a user.

  • You can retrieve the entity type, event type, level, limit, and time unit of a frequency cap using its methods.

  • The frequency cap can apply to impressions or video views.

  • The frequency cap can be set at the campaign, ad group, or ad group creative level.

  • The time unit for the frequency cap can be daily, weekly, or monthly.

Represents a Google Ads frequency cap.

Methods:

MemberTypeDescription
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:

TypeDescription
String Type of this entity: "FrequencyCap".

getEventType()

Returns type of event that the cap applies to. Possible return values:

IMPRESSION, VIDEO_VIEW

Return values:

TypeDescription
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:

TypeDescription
String The level on which the cap is to be applied.

getLimit()

Returns the cap number for the frequency cap.

Return values:

TypeDescription
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:

TypeDescription
String The unit of time the cap is defined at.