Reference documentation and code samples for the Google Analytics Admin V1alpha Client class ListReportingDataAnnotationsRequest.
Request message for ListReportingDataAnnotation RPC.
Generated from protobuf message google.analytics.admin.v1alpha.ListReportingDataAnnotationsRequest
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. Resource name of the property. Format: properties/property_id Example: properties/123 |
↳ filter |
string
Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * * 'name' * * |
↳ page_size |
int
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) |
↳ page_token |
string
Optional. A page token, received from a previous |
getParent
Required. Resource name of the property.
Format: properties/property_id Example: properties/123
Returns | |
---|---|
Type | Description |
string |
setParent
Required. Resource name of the property.
Format: properties/property_id Example: properties/123
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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.
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
andend_date
. The dates are in ISO-8601 format, for example2031-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 matchNOT
: Logical notAND
: Logical andOR
: 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
Returns | |
---|---|
Type | Description |
string |
setFilter
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
andend_date
. The dates are in ISO-8601 format, for example2031-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 matchNOT
: Logical notAND
: Logical andOR
: 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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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)
Returns | |
---|---|
Type | Description |
int |
setPageSize
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)
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
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.
Returns | |
---|---|
Type | Description |
string |
setPageToken
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. Resource name of the property. Format: properties/property_id Example: properties/123 Please see AnalyticsAdminServiceClient::propertyName() for help formatting this field. |
Returns | |
---|---|
Type | Description |
ListReportingDataAnnotationsRequest |