Class: Google::Apis::DfareportingV2_6::Report::Schedule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_6/classes.rb,
generated/google/apis/dfareporting_v2_6/representations.rb,
generated/google/apis/dfareporting_v2_6/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Schedule

Returns a new instance of Schedule.


10058
10059
10060
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10058

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#activeBoolean Also known as: active?

Whether the schedule is active or not. Must be set to either true or false. Corresponds to the JSON property active

Returns:

  • (Boolean)

10016
10017
10018
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10016

def active
  @active
end

#everyFixnum

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". Corresponds to the JSON property every

Returns:

  • (Fixnum)

10023
10024
10025
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10023

def every
  @every
end

#expiration_dateDate

The expiration date when the scheduled report stops running. Corresponds to the JSON property expirationDate

Returns:

  • (Date)

10028
10029
10030
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10028

def expiration_date
  @expiration_date
end

#repeatsString

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. Corresponds to the JSON property repeats

Returns:

  • (String)

10036
10037
10038
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10036

def repeats
  @repeats
end

#repeats_on_week_daysArray<String>

List of week days "WEEKLY" on which scheduled reports should run. Corresponds to the JSON property repeatsOnWeekDays

Returns:

  • (Array<String>)

10041
10042
10043
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10041

def repeats_on_week_days
  @repeats_on_week_days
end

#runs_on_day_of_monthString

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. Corresponds to the JSON property runsOnDayOfMonth

Returns:

  • (String)

10051
10052
10053
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10051

def runs_on_day_of_month
  @runs_on_day_of_month
end

#start_dateDate

Start date of date range for which scheduled reports should be run. Corresponds to the JSON property startDate

Returns:

  • (Date)

10056
10057
10058
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10056

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


10063
10064
10065
10066
10067
10068
10069
10070
10071
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 10063

def update!(**args)
  @active = args[:active] if args.key?(:active)
  @every = args[:every] if args.key?(:every)
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
  @repeats = args[:repeats] if args.key?(:repeats)
  @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days)
  @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month)
  @start_date = args[:start_date] if args.key?(:start_date)
end