Method: properties.reportingDataAnnotations.patch

  • This document details how to update a Reporting Data Annotation using a PATCH HTTP request.

  • The PATCH request is sent to a specific URL that uses gRPC Transcoding syntax.

  • The request requires the reportingDataAnnotation.name as a path parameter to identify the annotation to be updated.

  • An optional updateMask query parameter can be used to specify which fields of the Reporting Data Annotation should be updated.

  • The request and response bodies both contain an instance of a ReportingDataAnnotation.

  • The update operation requires the https://www.googleapis.com/auth/analytics.edit authorization scope.

Updates a Reporting Data Annotation.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{reportingDataAnnotation.name=properties/*/reportingDataAnnotations/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
reportingDataAnnotation.name

string

Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' Format: 'properties/123/reportingDataAnnotations/456'

Query parameters

Parameters
updateMask

string (FieldMask format)

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.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of ReportingDataAnnotation.

Response body

If successful, the response body contains an instance of ReportingDataAnnotation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit