Register for one of our upcoming AdWords scripts workshops.

AdWordsApp.​FrequencyCaps

FrequencyCaps provides access to each of the frequency cap.

Methods:

MemberTypeDescription
getEntityType String Returns the type of this entity as a String, in this case, "FrequencyCaps".
getFrequencyCapFor AdWordsApp.FrequencyCap Get frequency cap for the chosen event type.
newFrequencyCapBuilder AdWordsApp.FrequencyCapBuilder Returns a new frequency cap builder for the campaign that the frequency caps belong to.
removeFrequencyCapFor void Remove frequency cap for the chosen event type.

getEntityType()

Returns the type of this entity as a String, in this case, "FrequencyCaps".

Return values:

TypeDescription
String Type of this entity: "FrequencyCaps".

getFrequencyCapFor(eventType)

Get frequency cap for the chosen event type.

Arguments:

NameTypeDescription
eventType String The type of event that the cap applies to.

Return values:

TypeDescription
AdWordsApp.FrequencyCap The corresponding frequency cap with the event type.

newFrequencyCapBuilder()

Returns a new frequency cap builder for the campaign that the frequency caps belong to. When FrequencyCapBuilder.build() is called, an frequency cap will be added in this campaign.

Return values:

TypeDescription
AdWordsApp.FrequencyCapBuilder Frequency cap builder used to create a new frequency cap in the campaign.

removeFrequencyCapFor(eventType)

Remove frequency cap for the chosen event type.

Returns nothing.

Arguments:

NameTypeDescription
eventType String The type of event that the cap applies to. The value can be either IMPRESSION or VIDEO_VIEW.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.