Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customDimensions.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a CustomDimension on a property.
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1beta/{customDimension.name=properties/*/customDimensions/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customDimension.name |
string
Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
|
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 CustomDimension.
Response body
If successful, the response body contains an instance of CustomDimension.
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 page details how to update a CustomDimension on a Google Analytics 4 property using the \u003ccode\u003ePATCH\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the \u003ccode\u003ecustomDimension.name\u003c/code\u003e as a path parameter and an \u003ccode\u003eupdateMask\u003c/code\u003e as a query parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eCustomDimension\u003c/code\u003e object with the desired updates.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will return the updated \u003ccode\u003eCustomDimension\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, you need to authorize with the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details updating a CustomDimension on a property using a PATCH request. The URL structure, including path parameters, follows gRPC Transcoding syntax, specifying the CustomDimension's name. A required `updateMask` query parameter determines which fields to modify. The request and response bodies both use the `CustomDimension` resource. Authorization requires the `analytics.edit` OAuth scope. The `Try it!` link enables interactive testing.\n"],null,["# Method: properties.customDimensions.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 CustomDimension on a property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1beta/{customDimension.name=properties/*/customDimensions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `customDimension.name` | `string` Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |\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 [CustomDimension](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension).\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomDimension](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#CustomDimension).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
