Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customMetrics.patch
Stay organized with collections
Save and categorize content based on your preferences.
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
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\u003eThis 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.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify which fields to update with the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, using FieldMask format.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated CustomMetric data in JSON format, adhering to the CustomMetric schema.\u003c/p\u003e\n"],["\u003cp\u003eUpon success, the response body will contain the updated CustomMetric, also formatted according to the CustomMetric schema.\u003c/p\u003e\n"],["\u003cp\u003eTo use this method, your application needs to be authorized with the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details updating a CustomMetric on a property using a PATCH request to the specified URL: `https://analyticsadmin.googleapis.com/v1beta/{customMetric.name=properties/*/customMetrics/*}`. The `customMetric.name` is a required path parameter. The `updateMask` query parameter specifies fields to be updated. The request and response bodies both contain an instance of CustomMetric. This action requires the `https://www.googleapis.com/auth/analytics.edit` OAuth scope for authorization.\n"],null,["# Method: properties.customMetrics.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 CustomMetric on a property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1beta/{customMetric.name=properties/*/customMetrics/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `customMetric.name` | `string` Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} |\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 [CustomMetric](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#CustomMetric).\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomMetric](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customMetrics#CustomMetric).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
