type FrequencyCap (v201809)

Service

CampaignService

Dependencies

Campaign

▼

FrequencyCap

A frequency cap is the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.

Field
`impressions`	`xsd:long` Maximum number of impressions allowed during the time range by this cap. To remove the frequency cap on a campaign, set this field to `0`. This field can be selected using the value "FrequencyCapMaxImpressions". This field can be filtered on.
`timeUnit`	`TimeUnit` Unit of time the cap is defined at. Only the Day, Week and Month time units are supported. Enumerations `MINUTE` `HOUR` `DAY` `WEEK` `MONTH` `LIFETIME` This field can be selected using the value "TimeUnit". This field can be filtered on.
`level`	`Level` The level on which the cap is to be applied (creative/adgroup). Cap is applied to all the entities of this level in the campaign. Enumerations `CREATIVE` The cap is applied at the creative level. `ADGROUP` The cap is applied at the ad group level. `CAMPAIGN` The cap is applied at the campaign level. `UNKNOWN` This value cannot be set by the user and sent to the AdWords API servers, as it would generate a RejectedError. It can only be received by the user from the AdWords API servers and it means that a new value available in a newer API release version is not known in the current API release version. If the user encounters this value, it means an upgrade is required in order to take advantage of the latest AdWords API functionality. This field can be selected using the value "Level". This field can be filtered on.

Field

xsd:long

Maximum number of impressions allowed during the time range by this cap. To remove the frequency cap on a campaign, set this field to 0.

This field can be selected using the value "FrequencyCapMaxImpressions".

This field can be filtered on.

Unit of time the cap is defined at. Only the Day, Week and Month time units are supported.

Enumerations

This field can be selected using the value "TimeUnit".

This field can be filtered on.

The level on which the cap is to be applied (creative/adgroup). Cap is applied to all the entities of this level in the campaign.

Enumerations

CREATIVE: The cap is applied at the creative level.
ADGROUP: The cap is applied at the ad group level.
CAMPAIGN: The cap is applied at the campaign level.
UNKNOWN: This value cannot be set by the user and sent to the AdWords API servers, as it would generate a RejectedError. It can only be received by the user from the AdWords API servers and it means that a new value available in a newer API release version is not known in the current API release version. If the user encounters this value, it means an upgrade is required in order to take advantage of the latest AdWords API functionality.

This field can be selected using the value "Level".

This field can be filtered on.