2025-04-01
▼ ▲ analyticsadmin.properties.reportingDataAnnotations.create
HTTP Method : POST
Parameter Order : parent
Flat Path : v1alpha/properties/{propertiesId}/reportingDataAnnotations
Path : v1alpha/{+parent}/reportingDataAnnotations
Scopes : https://www.googleapis.com/auth/analytics.edit
Parameters :
parent
Location : path
Type : string
Required : Yes
Pattern : ^properties/[^/]+$
Description : Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123
Description : Creates a Reporting Data Annotation.
▼ ▲ analyticsadmin.properties.reportingDataAnnotations.patch
Description : Updates a Reporting Data Annotation.
HTTP Method : PATCH
Flat Path : v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
Location : path
Description : Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'
Pattern : ^properties/[^/]+/reportingDataAnnotations/[^/]+$
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Optional. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Path : v1alpha/{+name}
▼ ▲ analyticsadmin.properties.reportingDataAnnotations.get
Flat Path : v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
HTTP Method : GET
Scopes :
Parameters :
name
Location : path
Description : Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456
Pattern : ^properties/[^/]+/reportingDataAnnotations/[^/]+$
Required : Yes
Type : string
Path : v1alpha/{+name}
Parameter Order : name
Description : Lookup a single Reporting Data Annotation.
▼ ▲ analyticsadmin.properties.reportingDataAnnotations.list
Path : v1alpha/{+parent}/reportingDataAnnotations
Scopes :
HTTP Method : GET
Parameter Order : parent
Description : List all Reporting Data Annotations on a property.
Flat Path : v1alpha/properties/{propertiesId}/reportingDataAnnotations
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : 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)
filter
Type : string
Location : query
Description : 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`
parent
Required : Yes
Location : path
Type : string
Description : Required. Resource name of the property. Format: properties/property_id Example: properties/123
Pattern : ^properties/[^/]+$
pageToken
Location : query
Type : string
Description : 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.
▼ ▲ analyticsadmin.properties.reportingDataAnnotations.delete
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/analytics.edit
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}
Parameters :
name
Type : string
Pattern : ^properties/[^/]+/reportingDataAnnotations/[^/]+$
Description : Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456
Required : Yes
Location : path
Description : Deletes a Reporting Data Annotation.