View Source GoogleApi.DisplayVideo.V1.Model.FrequencyCap (google_api_display_video v0.30.2)

Settings that control the number of times a user may be shown with the same ad during a given time period.

Attributes

  • maxImpressions (type: integer(), default: nil) - The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Required when unlimited is false.
  • timeUnit (type: String.t, default: nil) - The time unit in which the frequency cap will be applied. Required when unlimited is false.
  • timeUnitCount (type: integer(), default: nil) - The number of time_unit the frequency cap will last. Required when unlimited is false. The following restrictions apply based on the value of time_unit: TIME_UNIT_LIFETIME - this field is output only and will default to 1 TIME_UNIT_MONTHS - must be between 1 and 2 TIME_UNIT_WEEKS - must be between 1 and 4 TIME_UNIT_DAYS - must be between 1 and 6 TIME_UNIT_HOURS - must be between 1 and 23 TIME_UNIT_MINUTES - must be between 1 and 59
  • unlimited (type: boolean(), default: nil) - Whether unlimited frequency capping is applied. When this field is set to true, the remaining frequency cap fields are not applicable.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.DisplayVideo.V1.Model.FrequencyCap{
  maxImpressions: integer() | nil,
  timeUnit: String.t() | nil,
  timeUnitCount: integer() | nil,
  unlimited: boolean() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.