Package com.google.analytics.admin.v1alpha

Interface ListReportingDataAnnotationsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListReportingDataAnnotationsRequest, ListReportingDataAnnotationsRequest.Builder

@Generated
public interface ListReportingDataAnnotationsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getFilter()	Optional.
com.google.protobuf.ByteString	getFilterBytes()	Optional.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
String	getParent()	Required.
com.google.protobuf.ByteString	getParentBytes()	Required.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getParent

String getParent()

 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) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 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) = { ... }

Returns:

The bytes for parent.

getFilter

String getFilter()

 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](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto).
 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](https://github.com/google/re2/wiki/Syntax)
 match
 * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 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`
 

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

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto).
 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](https://github.com/google/re2/wiki/Syntax)
 match
 * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax)
 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`
 

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

Returns:

The bytes for filter.

getPageSize

int getPageSize()

 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];

Returns:

The pageSize.

getPageToken

String getPageToken()

 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];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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];

Returns:

The bytes for pageToken.