Class ListReportingDataAnnotationsRequest

Request message for ListReportingDataAnnotation RPC.

Inheritance

object

ListReportingDataAnnotationsRequest

Implements

IMessage<ListReportingDataAnnotationsRequest>

IEquatable<ListReportingDataAnnotationsRequest>

IDeepCloneable<ListReportingDataAnnotationsRequest>

IBufferMessage

IMessage

IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class ListReportingDataAnnotationsRequest : IMessage<ListReportingDataAnnotationsRequest>, IEquatable<ListReportingDataAnnotationsRequest>, IDeepCloneable<ListReportingDataAnnotationsRequest>, IBufferMessage, IMessage, IPageRequest

Constructors

ListReportingDataAnnotationsRequest()

Declaration

public ListReportingDataAnnotationsRequest()

ListReportingDataAnnotationsRequest(ListReportingDataAnnotationsRequest)

Declaration

public ListReportingDataAnnotationsRequest(ListReportingDataAnnotationsRequest other)

Parameters

Type	Name	Description
ListReportingDataAnnotationsRequest	other

Properties

Filter

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

Declaration

public string Filter { get; set; }

Property Value

Type	Description
string

PageSize

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)

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

Implements

IPageRequest.PageSize

PageToken

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.

Declaration

public string PageToken { get; set; }

Property Value

Type	Description
string

Implements

IPageRequest.PageToken

Parent

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

Declaration

public string Parent { get; set; }

Property Value

Type	Description
string

ParentAsPropertyName

PropertyName-typed view over the Parent resource name property.

Declaration

public PropertyName ParentAsPropertyName { get; set; }

Property Value

Type	Description
PropertyName