Class: Google::Analytics::Admin::V1alpha::ListReportingDataAnnotationsRequest

Inherits:

Object

• Object
• Google::Analytics::Admin::V1alpha::ListReportingDataAnnotationsRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

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

Overview

Request message for ListReportingDataAnnotation RPC.

Instance Attribute Summary

• #filter ⇒ ::String

  Optional.

• #page_size ⇒ ::Integer

  Optional.

• #page_token ⇒ ::String

  Optional.

• #parent ⇒ ::String

  Required.

Instance Attribute Details

#filter ⇒ ::String

Returns Optional. Filter that restricts which reporting data annotations under the parent property are listed.

Supported fields are:

• 'name'
• title
• description
• annotation_date
• annotation_date_range
• color

Additionally, this API provides the following helper functions:

• annotation_duration() : the duration that this annotation marks, durations. expect a numeric representation of seconds followed by an s suffix.
• is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the start_date and end_date. The dates are in ISO-8601 format, for example 2031-06-28.

Supported operations:

• = : equals
• != : not equals
• < : less than
• > : greater than
• <= : less than or equals
• >= : greater than or equals
• : : has operator
• =~ : regular expression match
• !~ : regular expression does not match
• NOT : Logical not
• AND : Logical and
• OR : Logical or

Examples:

1. title="Holiday Sale"
2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
4. annotation_duration() >= 172800s AND title:BOGO.

Returns:

• (::String) —

  Optional. Filter that restricts which reporting data annotations under the parent property are listed.

  Supported fields are:

  • 'name'
  • title
  • description
  • annotation_date
  • annotation_date_range
  • color

  Additionally, this API provides the following helper functions:

  • annotation_duration() : the duration that this annotation marks, durations. expect a numeric representation of seconds followed by an s suffix.
  • is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the start_date and end_date. The dates are in ISO-8601 format, for example 2031-06-28.

  Supported operations:

  • = : equals
  • != : not equals
  • < : less than
  • > : greater than
  • <= : less than or equals
  • >= : greater than or equals
  • : : has operator
  • =~ : regular expression match
  • !~ : regular expression does not match
  • NOT : Logical not
  • AND : Logical and
  • OR : Logical or

  Examples:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 2781

class ListReportingDataAnnotationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum).

Returns:

• (::Integer) —

  Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 2781

class ListReportingDataAnnotationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. A page token, received from a previous ListReportingDataAnnotations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListReportingDataAnnotations must match the call that provided the page token.

Returns:

• (::String) —

  Optional. A page token, received from a previous ListReportingDataAnnotations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListReportingDataAnnotations must match the call that provided the page token.

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 2781

class ListReportingDataAnnotationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. Resource name of the property. Format: properties/property_id Example: properties/123.

Returns:

• (::String) —

  Required. Resource name of the property. Format: properties/property_id Example: properties/123

# File 'proto_docs/google/analytics/admin/v1alpha/analytics_admin.rb', line 2781

class ListReportingDataAnnotationsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end