Class ListReportingDataAnnotationsRequest (0.72.0)

Stay organized with collections Save and categorize content based on your preferences.

Request message for ListReportingDataAnnotation RPC.

Protobuf type google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest

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:

• title="Holiday Sale"

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

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:

• title="Holiday Sale"

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

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

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)

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }