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/v1alpha/{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\u003eUpdates a specified CustomDimension on a Google Analytics 4 property using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request should target a URL containing the property and CustomDimension identifiers, using gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eUsers must provide an \u003ccode\u003eupdateMask\u003c/code\u003e query parameter to specify the fields to update within the CustomDimension.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a CustomDimension object with the desired changes and the response will contain the updated CustomDimension.\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 details updating a CustomDimension on a property using a PATCH request. The endpoint is `https://analyticsadmin.googleapis.com/v1alpha/{customDimension.name=properties/*/customDimensions/*}`. Required parameters include the `customDimension.name` path parameter and the `updateMask` query parameter, which specifies fields to be updated. The request body contains a CustomDimension instance, and the successful response returns an updated CustomDimension instance. The process requires `https://www.googleapis.com/auth/analytics.edit` authorization scope.\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/v1alpha/{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/v1alpha/properties.customDimensions#CustomDimension).\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomDimension](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions#CustomDimension).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
