Class: Google::Ads::AdManager::V1::Report::DateRange

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

A date range for a report.

Defined Under Namespace

Modules: RelativeDateRange Classes: FixedDateRange

Instance Attribute Summary collapse

Instance Attribute Details

#fixed ⇒ ::Google::Ads::AdManager::V1::Report::DateRange::FixedDateRange

Returns A fixed date range.

Returns:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 347

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

  # A date range between two fixed dates (inclusive of end date).
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date of this date range.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date (inclusive) of this date range.
  class FixedDateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for relative date ranges.
  module RelativeDateRange
    # Default value. This value is unused.
    RELATIVE_DATE_RANGE_UNSPECIFIED = 0

    # The date the report is run.
    TODAY = 1

    # The date a day before the date that the report is run.
    YESTERDAY = 2

    # The full week in which this report is run. Could include dates in
    # the future.
    THIS_WEEK = 3

    # From the beginning of the calendar week (Monday to Sunday) in which the
    # up to and including the day the report is run.
    THIS_WEEK_TO_DATE = 29

    # The full month in which this report is run. Could include dates in
    # the future.
    THIS_MONTH = 4

    # From the beginning of the calendar month in which the report is run, to
    # up to and including the day the report is run.
    THIS_MONTH_TO_DATE = 26

    # The full quarter in which this report is run. Could include dates
    # in the future.
    THIS_QUARTER = 5

    # From the beginning of the calendar quarter in which the report is run,
    # up to and including the day the report is run.
    THIS_QUARTER_TO_DATE = 27

    # The full year in which this report is run. Could include dates in
    # the future.
    THIS_YEAR = 6

    # From the beginning of the calendar year in which the report is run, to
    # up to and including the day the report is run.
    THIS_YEAR_TO_DATE = 28

    # The entire previous calendar week, Monday to Sunday (inclusive),
    # preceding the calendar week the report is run.
    LAST_WEEK = 7

    # The entire previous calendar month preceding the calendar month the
    # report is run.
    LAST_MONTH = 8

    # The entire previous calendar quarter preceding the calendar quarter the
    # report is run.
    LAST_QUARTER = 9

    # The entire previous calendar year preceding the calendar year the
    # report is run.
    LAST_YEAR = 10

    # The 7 days preceding the day the report is run.
    LAST_7_DAYS = 11

    # The 30 days preceding the day the report is run.
    LAST_30_DAYS = 12

    # The 60 days preceding the day the report is run.
    LAST_60_DAYS = 13

    # The 90 days preceding the day the report is run.
    LAST_90_DAYS = 14

    # The 180 days preceding the day the report is run.
    LAST_180_DAYS = 15

    # The 360 days preceding the day the report is run.
    LAST_360_DAYS = 16

    # The 365 days preceding the day the report is run.
    LAST_365_DAYS = 17

    # The entire previous 3 calendar months preceding the calendar month the
    # report is run.
    LAST_3_MONTHS = 18

    # The entire previous 6 calendar months preceding the calendar month the
    # report is run.
    LAST_6_MONTHS = 19

    # The entire previous 6 calendar months preceding the calendar month the
    # report is run.
    LAST_12_MONTHS = 20

    # From 3 years before the report is run, to the day before the report is
    # run, inclusive.
    ALL_AVAILABLE = 21

    # Only valid when used in the comparison_date_range field. The complete
    # period preceding the date period provided in date_range.
    #
    # In the case where date_range is a FixedDateRange of N days, this will
    # be a period of N days where the end date is the date preceding the
    # start date of the date_range.
    #
    # In the case where date_range is a RelativeDateRange, this will be a
    # period of the same time frame preceding the date_range. In the case
    # where the date_range does not capture the full period because a report
    # is run in the middle of that period, this will still be the full
    # preceding period. For example, if date_range is THIS_WEEK, but the
    # report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but
    # PREVIOUS_PERIOD will be Monday - Sunday.
    PREVIOUS_PERIOD = 22

    # Only valid when used in the comparison_date_range field. The period
    # starting 1 year prior to the date period provided in date_range.
    #
    # In the case where date_range is a FixedDateRange, this will be a date
    # range starting 1 year prior to the date_range start date and ending 1
    # year prior to the date_range end date.
    #
    # In the case where date_range is a RelativeDateRange, this will be a
    # period of the same time frame exactly 1 year prior to the date_range.
    # In the case where the date_range does not capture the full period
    # because a report is run in the middle of that period, this will still
    # be the full period 1 year prior. For example, if date range is
    # THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be
    # Monday - Wednesday, but SAME_PERIOD_PREVIOUS_YEAR will be Monday -
    # Sunday.
    SAME_PERIOD_PREVIOUS_YEAR = 24
  end
end

#relative ⇒ ::Google::Ads::AdManager::V1::Report::DateRange::RelativeDateRange

Returns A relative date range.

Returns:



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'proto_docs/google/ads/admanager/v1/report_service.rb', line 347

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

  # A date range between two fixed dates (inclusive of end date).
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date of this date range.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date (inclusive) of this date range.
  class FixedDateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options for relative date ranges.
  module RelativeDateRange
    # Default value. This value is unused.
    RELATIVE_DATE_RANGE_UNSPECIFIED = 0

    # The date the report is run.
    TODAY = 1

    # The date a day before the date that the report is run.
    YESTERDAY = 2

    # The full week in which this report is run. Could include dates in
    # the future.
    THIS_WEEK = 3

    # From the beginning of the calendar week (Monday to Sunday) in which the
    # up to and including the day the report is run.
    THIS_WEEK_TO_DATE = 29

    # The full month in which this report is run. Could include dates in
    # the future.
    THIS_MONTH = 4

    # From the beginning of the calendar month in which the report is run, to
    # up to and including the day the report is run.
    THIS_MONTH_TO_DATE = 26

    # The full quarter in which this report is run. Could include dates
    # in the future.
    THIS_QUARTER = 5

    # From the beginning of the calendar quarter in which the report is run,
    # up to and including the day the report is run.
    THIS_QUARTER_TO_DATE = 27

    # The full year in which this report is run. Could include dates in
    # the future.
    THIS_YEAR = 6

    # From the beginning of the calendar year in which the report is run, to
    # up to and including the day the report is run.
    THIS_YEAR_TO_DATE = 28

    # The entire previous calendar week, Monday to Sunday (inclusive),
    # preceding the calendar week the report is run.
    LAST_WEEK = 7

    # The entire previous calendar month preceding the calendar month the
    # report is run.
    LAST_MONTH = 8

    # The entire previous calendar quarter preceding the calendar quarter the
    # report is run.
    LAST_QUARTER = 9

    # The entire previous calendar year preceding the calendar year the
    # report is run.
    LAST_YEAR = 10

    # The 7 days preceding the day the report is run.
    LAST_7_DAYS = 11

    # The 30 days preceding the day the report is run.
    LAST_30_DAYS = 12

    # The 60 days preceding the day the report is run.
    LAST_60_DAYS = 13

    # The 90 days preceding the day the report is run.
    LAST_90_DAYS = 14

    # The 180 days preceding the day the report is run.
    LAST_180_DAYS = 15

    # The 360 days preceding the day the report is run.
    LAST_360_DAYS = 16

    # The 365 days preceding the day the report is run.
    LAST_365_DAYS = 17

    # The entire previous 3 calendar months preceding the calendar month the
    # report is run.
    LAST_3_MONTHS = 18

    # The entire previous 6 calendar months preceding the calendar month the
    # report is run.
    LAST_6_MONTHS = 19

    # The entire previous 6 calendar months preceding the calendar month the
    # report is run.
    LAST_12_MONTHS = 20

    # From 3 years before the report is run, to the day before the report is
    # run, inclusive.
    ALL_AVAILABLE = 21

    # Only valid when used in the comparison_date_range field. The complete
    # period preceding the date period provided in date_range.
    #
    # In the case where date_range is a FixedDateRange of N days, this will
    # be a period of N days where the end date is the date preceding the
    # start date of the date_range.
    #
    # In the case where date_range is a RelativeDateRange, this will be a
    # period of the same time frame preceding the date_range. In the case
    # where the date_range does not capture the full period because a report
    # is run in the middle of that period, this will still be the full
    # preceding period. For example, if date_range is THIS_WEEK, but the
    # report is run on a Wednesday, THIS_WEEK will be Monday - Wednesday, but
    # PREVIOUS_PERIOD will be Monday - Sunday.
    PREVIOUS_PERIOD = 22

    # Only valid when used in the comparison_date_range field. The period
    # starting 1 year prior to the date period provided in date_range.
    #
    # In the case where date_range is a FixedDateRange, this will be a date
    # range starting 1 year prior to the date_range start date and ending 1
    # year prior to the date_range end date.
    #
    # In the case where date_range is a RelativeDateRange, this will be a
    # period of the same time frame exactly 1 year prior to the date_range.
    # In the case where the date_range does not capture the full period
    # because a report is run in the middle of that period, this will still
    # be the full period 1 year prior. For example, if date range is
    # THIS_WEEK, but the report is run on a Wednesday, THIS_WEEK will be
    # Monday - Wednesday, but SAME_PERIOD_PREVIOUS_YEAR will be Monday -
    # Sunday.
    SAME_PERIOD_PREVIOUS_YEAR = 24
  end
end