GoogleApi.DFAReporting.V33.Model.ReportSchedule (google_api_dfa_reporting v0.31.0)

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not "TODAY".

Attributes

active (type: boolean(), default: nil) - Whether the schedule is active or not. Must be set to either true or false.
every (type: integer(), default: nil) - Defines every how many days, weeks or months the report should be run. Needs to be set when "repeats" is either "DAILY", "WEEKLY" or "MONTHLY".
expirationDate (type: Date.t, default: nil) -
repeats (type: String.t, default: nil) - The interval for which the report is repeated. Note: - "DAILY" also requires field "every" to be set. - "WEEKLY" also requires fields "every" and "repeatsOnWeekDays" to be set. - "MONTHLY" also requires fields "every" and "runsOnDayOfMonth" to be set.
repeatsOnWeekDays (type: list(String.t), default: nil) - List of week days "WEEKLY" on which scheduled reports should run.
runsOnDayOfMonth (type: String.t, default: nil) - Enum to define for "MONTHLY" scheduled reports whether reports should be repeated on the same day of the month as "startDate" or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04-02), "DAY_OF_MONTH" would run subsequent reports on the 2nd of every Month, and "WEEK_OF_MONTH" would run subsequent reports on the first Monday of the month.
startDate (type: Date.t, default: nil) -

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DFAReporting.V33.Model.ReportSchedule{
  active: boolean() | nil,
  every: integer() | nil,
  expirationDate: Date.t() | nil,
  repeats: String.t() | nil,
  repeatsOnWeekDays: [String.t()] | nil,
  runsOnDayOfMonth: String.t() | nil,
  startDate: Date.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.