Method: properties.calculatedMetrics.patch

  • This page details how to update a CalculatedMetric on a property using a PATCH HTTP request.

  • The request requires a calculatedMetric.name path parameter specifying the resource to update and an updateMask query parameter indicating which fields to modify.

  • The request body should contain an instance of the CalculatedMetric with the desired updates.

  • A successful response will return the updated CalculatedMetric in the response body.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

Updates a CalculatedMetric on a property.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{calculatedMetric.name=properties/*/calculatedMetrics/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
calculatedMetric.name

string

Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'

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 CalculatedMetric.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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