Class: Google::Apis::DfareportingV3_3::Report::Schedule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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.



10369
10370
10371
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10369

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

Instance Attribute Details

#active ⇒ Boolean 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) 


10327
10328
10329
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10327

def active
  @active
end

#every ⇒ Fixnum

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) 


10334
10335
10336
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10334

def every
  @every
end

#expiration_date ⇒ Date

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

Returns:

  • (Date) 


10339
10340
10341
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10339

def expiration_date
  @expiration_date
end

#repeats ⇒ String

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) 


10347
10348
10349
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10347

def repeats
  @repeats
end

#repeats_on_week_days ⇒ Array<String>

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

Returns:

  • (Array<String>) 


10352
10353
10354
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10352

def repeats_on_week_days
  @repeats_on_week_days
end

#runs_on_day_of_month ⇒ String

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) 


10362
10363
10364
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10362

def runs_on_day_of_month
  @runs_on_day_of_month
end

#start_date ⇒ Date

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

Returns:

  • (Date) 


10367
10368
10369
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10367

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10374
10375
10376
10377
10378
10379
10380
10381
10382
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10374

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