Class: Google::Ads::AdManager::V1::ScheduleOptions::Schedule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/report_messages.rb

Overview

The schedule for the report

Defined Under Namespace

Modules: Frequency Classes: MonthlySchedule, WeeklySchedule

Instance Attribute Summary collapse

Instance Attribute Details

#end_date ⇒ ::Google::Type::Date

Returns Date for the final run of the report.

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end

#frequency ⇒ ::Google::Ads::AdManager::V1::ScheduleOptions::Schedule::Frequency

Returns Frequency to run report.

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end

#monthly_schedule ⇒ ::Google::Ads::AdManager::V1::ScheduleOptions::Schedule::MonthlySchedule

Returns Days of month to schedule report run.

Note: The following fields are mutually exclusive: monthly_schedule, weekly_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end

#start_date ⇒ ::Google::Type::Date

Returns Date for the first run of the report.

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end

#start_time ⇒ ::Google::Type::TimeOfDay

Returns Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

Returns:

  • (::Google::Type::TimeOfDay) —

    Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

    For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end

#weekly_schedule ⇒ ::Google::Ads::AdManager::V1::ScheduleOptions::Schedule::WeeklySchedule

Returns Days of week to schedule report run.

Note: The following fields are mutually exclusive: weekly_schedule, monthly_schedule. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/ads/admanager/v1/report_messages.rb', line 181

class Schedule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Days of week to schedule report run.
  # @!attribute [rw] weekly_scheduled_days
  #   @return [::Array<::Google::Type::DayOfWeek>]
  #     Specifies days of the week on which to run report.
  class WeeklySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Days of Month to schedule report run.
  # @!attribute [rw] monthly_scheduled_days
  #   @return [::Array<::Integer>]
  #     Specifies days of the month to run report. Range is from 1-31.
  #     Will ignore days that are not valid for the given month.
  class MonthlySchedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Frequency to run report.
  module Frequency
    # No Frequency specified.
    FREQUENCY_UNSPECIFIED = 0

    # Schedule report to run every hour.
    HOURLY = 1

    # Schedule report to run twice a day (every 12 hours).
    TWO_TIMES_DAILY = 2

    # Schedule report to run three times a day (every 8 hours).
    THREE_TIMES_DAILY = 3

    # Schedule report to run four times a day (every 6 hours).
    FOUR_TIMES_DAILY = 4

    # Schedule report to run on a daily basis.
    DAILY = 5

    # Schedule report to run on a weekly basis.
    WEEKLY = 6

    # Schedule report to run on a monthly basis.
    MONTHLY = 7
  end
end