Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.calculatedMetrics.patch
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eUpdates a CalculatedMetric on a property using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request should be sent to the URL \u003ccode\u003ehttps://analyticsadmin.googleapis.com/v1alpha/{calculatedMetric.name=properties/*/calculatedMetrics/*}\u003c/code\u003e with required path and query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a \u003ccode\u003eCalculatedMetric\u003c/code\u003e object, and a successful response will also return a \u003ccode\u003eCalculatedMetric\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for updating a CalculatedMetric on a property using a PATCH request. The endpoint is `https://analyticsadmin.googleapis.com/v1alpha/{calculatedMetric.name=properties/*/calculatedMetrics/*}`, defined using gRPC Transcoding. The `calculatedMetric.name` path parameter specifies the resource, while `updateMask` in the query parameters dictates which fields to update. The request and response bodies use the `CalculatedMetric` resource. This operation requires the `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"],null,["# Method: properties.calculatedMetrics.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a CalculatedMetric on a property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{calculatedMetric.name=properties/*/calculatedMetrics/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\n| `calculatedMetric.name` | `string` Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}' |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [CalculatedMetric](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#CalculatedMetric).\n\n### Response body\n\nIf successful, the response body contains an instance of [CalculatedMetric](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.calculatedMetrics#CalculatedMetric).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
