Method: properties.customDimensions.patch

  • Updates a specified CustomDimension on a Google Analytics 4 property using an HTTP PATCH request.

  • The request should target a URL containing the property and CustomDimension identifiers, using gRPC Transcoding syntax.

  • Users must provide an updateMask query parameter to specify the fields to update within the CustomDimension.

  • The request body must contain a CustomDimension object with the desired changes and the response will contain the updated CustomDimension.

  • Authorization requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

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