Class: Google::Apis::DfareportingV4::Report::Schedule

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

Constructor Details

#initialize(**args) ⇒ Schedule

Returns a new instance of Schedule.



10939
10940
10941
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10939

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) 


10892
10893
10894
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10892

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) 


10899
10900
10901
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10899

def every
  @every
end

#expiration_date ⇒ Date

Corresponds to the JSON property expirationDate

Returns:

  • (Date) 


10904
10905
10906
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10904

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) 


10912
10913
10914
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10912

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


10917
10918
10919
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10917

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) 


10927
10928
10929
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10927

def runs_on_day_of_month
  @runs_on_day_of_month
end

#start_date ⇒ Date

Corresponds to the JSON property startDate

Returns:

  • (Date) 


10932
10933
10934
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10932

def start_date
  @start_date
end

#timezone ⇒ String

The timezone when the report will run. Corresponds to the JSON property timezone

Returns:

  • (String) 


10937
10938
10939
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10937

def timezone
  @timezone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10944

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)
  @timezone = args[:timezone] if args.key?(:timezone)
end