AdsApp.​FrequencyCapBuilder

AI-generated Key Takeaways

• 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.

Builder for FrequencyCap objects.

Methods:

Member	Type	Description
build()	void	Builds the frequency cap.
withEventType(eventType)	AdsApp.FrequencyCapBuilder	Set the event type to the new frequency cap.
withLimit(limit)	AdsApp.FrequencyCapBuilder	Set the cap number to the new frequency cap.
withTimeUnit(timeUnit)	AdsApp.FrequencyCapBuilder	Set the time unit to the new frequency cap.

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:

Type	Description
AdsApp.FrequencyCapBuilder	The frequency cap builder with the specified event type.

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:

Type	Description
AdsApp.FrequencyCapBuilder	The frequency cap builder with the specified cap number.

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:

Type	Description
AdsApp.FrequencyCapBuilder	The frequency cap builder with the specified time unit.