Method: properties.customDimensions.patch

  • The method updates a CustomDimension on a property.

  • The HTTP request uses a PATCH method with a URL following gRPC Transcoding syntax, specifying the custom dimension by name.

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

  • The request and response bodies contain an instance of a CustomDimension.

  • The request requires the https://www.googleapis.com/auth/analytics.edit authorization 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