Class PropertiesResource.ReportingDataAnnotationsResource.ListRequest

List all Reporting Data Annotations on a property.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse>
GoogleAnalyticsAdminBaseServiceRequest<GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse>
PropertiesResource.ReportingDataAnnotationsResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.GoogleAnalyticsAdmin.v1alpha
Assembly: Google.Apis.GoogleAnalyticsAdmin.v1alpha.dll
Syntax
public class PropertiesResource.ReportingDataAnnotationsResource.ListRequest : GoogleAnalyticsAdminBaseServiceRequest<GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse>, IClientServiceRequest<GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

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 * &lt; : less than * &gt; : greater than

  • &lt;= : less than or equals * &gt;= : 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() &gt;= 172800s AND title:BOGO
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

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
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

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
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements