Class: Google::Analytics::Admin::V1alpha::ReportingDataAnnotation

Inherits:

Object

• Object
• Google::Analytics::Admin::V1alpha::ReportingDataAnnotation

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/analytics/admin/v1alpha/resources.rb

Overview

A Reporting Data Annotation is a comment connected to certain dates for reporting data.

Defined Under Namespace

Modules: Color Classes: DateRange

Instance Attribute Summary

• #annotation_date ⇒ ::Google::Type::Date

  If set, the Reporting Data Annotation is for a specific date represented by this field.

• #annotation_date_range ⇒ ::Google::Analytics::Admin::V1alpha::ReportingDataAnnotation::DateRange

  If set, the Reporting Data Annotation is for a range of dates represented by this field.

• #color ⇒ ::Google::Analytics::Admin::V1alpha::ReportingDataAnnotation::Color

  Required.

• #description ⇒ ::String

  Optional.

• #name ⇒ ::String

  Required.

• #system_generated ⇒ ::Boolean readonly

  Output only.

• #title ⇒ ::String

  Required.

Instance Attribute Details

#annotation_date ⇒ ::Google::Type::Date

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#annotation_date_range ⇒ ::Google::Analytics::Admin::V1alpha::ReportingDataAnnotation::DateRange

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#color ⇒ ::Google::Analytics::Admin::V1alpha::ReportingDataAnnotation::Color

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#description ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#name ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#system_generated ⇒ ::Boolean (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end

#title ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1698

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

  # Represents a Reporting Data Annotation's date range, both start and end
  # dates are inclusive. Time zones are based on the parent property.
  # @!attribute [rw] start_date
  #   @return [::Google::Type::Date]
  #     Required. The start date for this range. Must be a valid date with
  #     year, month, and day set. The date may be in the past, present, or
  #     future.
  # @!attribute [rw] end_date
  #   @return [::Google::Type::Date]
  #     Required. The end date for this range. Must be a valid date with
  #     year, month, and day set. This date must be greater than or equal to
  #     the start date.
  class DateRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Colors that may be used for this Reporting Data Annotation
  module Color
    # Color unknown or not specified.
    COLOR_UNSPECIFIED = 0

    # Purple color.
    PURPLE = 1

    # Brown color.
    BROWN = 2

    # Blue color.
    BLUE = 3

    # Green color.
    GREEN = 4

    # Red color.
    RED = 5

    # Cyan color.
    CYAN = 6

    # Orange color. (Only used for system-generated annotations)
    ORANGE = 7
  end
end