Method: properties.customMetrics.patch

  • The PATCH request updates a CustomMetric on a property.

  • The URL uses gRPC Transcoding syntax for the HTTP request.

  • The customMetric.name parameter is an output-only string representing the resource name.

  • The updateMask query parameter is required and specifies the fields to be updated using a FieldMask format.

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

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

Updates a CustomMetric on a property.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1beta/{customMetric.name=properties/*/customMetrics/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customMetric.name

string

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to be updated. 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 CustomMetric.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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