Method: properties.customDimensions.patch

  • This page details how to update a CustomDimension on a Google Analytics 4 property using the PATCH method.

  • The request requires specifying the customDimension.name as a path parameter and an updateMask as a query parameter.

  • The request body should contain a CustomDimension object with the desired updates.

  • A successful response will return the updated CustomDimension object.

  • To use this API, you need to authorize with the https://www.googleapis.com/auth/analytics.edit scope.

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