Class: Google::Ads::AdManager::V1::ReportDefinition::DateRange

Inherits:

Object

Object
Google::Ads::AdManager::V1::ReportDefinition::DateRange

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/ads/admanager/v1/report_definition.rb

Overview

A date range for a report.

Defined Under Namespace

Modules: RelativeDateRange Classes: FixedDateRange

Instance Attribute Summary collapse

#fixed ⇒ ::Google::Ads::AdManager::V1::ReportDefinition::DateRange::FixedDateRange
A fixed date range.
#relative ⇒ ::Google::Ads::AdManager::V1::ReportDefinition::DateRange::RelativeDateRange
A relative date range.

Instance Attribute Details

#fixed ⇒ `::Google::Ads::AdManager::V1::ReportDefinition::DateRange::FixedDateRange`

Returns A fixed date range.

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

Returns:

(::Google::Ads::AdManager::V1::ReportDefinition::DateRange::FixedDateRange) —
A fixed date range.

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

# File 'proto_docs/google/ads/admanager/v1/report_definition.rb', line 130

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

    # The date a day after the date that the report is run.
    TOMORROW = 30

    # The 90 days following the day the report is run.
    NEXT_90_DAYS = 31

    # The entire calendar month following the calendar month the report is
    # run.
    NEXT_MONTH = 32

    # The entire 3 calendar months following the calendar month the report
    # is run.
    NEXT_3_MONTHS = 33

    # The entire 12 calendar months following the calendar month the report
    # is run.
    NEXT_12_MONTHS = 34

    # The entire calendar week, Monday to Sunday (inclusive), following the
    # calendar week the report is run.
    NEXT_WEEK = 35

    # The entire calendar quarter following the calendar quarter the report
    # is run.
    NEXT_QUARTER = 36

    # From the date a day after the date that the report is run, to the end
    # of the calendar month following the calendar month the report is run.
    TO_END_OF_NEXT_MONTH = 37

    # 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 timeframe 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 timeframe 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::ReportDefinition::DateRange::RelativeDateRange`

Returns A relative date range.

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