Class: Google::Apis::DfareportingV2_3::Report::Schedule

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


9476
9477
9478
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9476

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)

9434
9435
9436
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9434

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)

9441
9442
9443
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9441

def every
  @every
end

#expiration_dateDate

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

Returns:

  • (Date)

9446
9447
9448
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9446

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)

9454
9455
9456
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9454

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>)

9459
9460
9461
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9459

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)

9469
9470
9471
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9469

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)

9474
9475
9476
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9474

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9481
9482
9483
9484
9485
9486
9487
9488
9489
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9481

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