FrequencyCapKey

  • Frequency cap keys are a group of fields used for a frequency cap, with no more than one frequency cap sharing the same key.

  • Key fields include level, event_type, time_unit, and time_length, which define how the cap is applied.

  • The level specifies where the cap applies (e.g., ad group ad), and the event_type indicates the event it applies to (e.g., impression).

  • time_unit and time_length together define the duration of the frequency cap.

A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key.

Fields

level

FrequencyCapLevel

The level on which the cap is to be applied (for example, ad group ad, ad group). The cap is applied to all the entities of this level.

event_type

FrequencyCapEventType

The type of event that the cap applies to (for example, impression).

time_unit

FrequencyCapTimeUnit

Unit of time the cap is defined at (for example, day, week).

time_length

int32

Number of time units the cap lasts.