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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/report_service.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:



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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::Schedule::Frequency

Returns Frequency to run report.

Returns:



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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::Schedule::MonthlySchedule

Returns Days of month to schedule report run.

Returns:



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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:



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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.



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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::Schedule::WeeklySchedule

Returns Days of week to schedule report run.

Returns:



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 3423

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