Method: properties.customMetrics.patch

  • This method updates a CustomMetric on a Google Analytics 4 property using an HTTP PATCH request to a specific endpoint with the CustomMetric's name in the path.

  • You can specify which fields to update with the updateMask query parameter, using FieldMask format.

  • The request body should contain the updated CustomMetric data in JSON format, adhering to the CustomMetric schema.

  • Upon success, the response body will contain the updated CustomMetric, also formatted according to the CustomMetric schema.

  • To use this method, your application needs to be authorized with the https://www.googleapis.com/auth/analytics.edit OAuth 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