Method: properties.customDimensions.archive

  • Archives a specified CustomDimension associated with a Google Analytics 4 property.

  • Requires an empty request body and uses the POST method with a specific URL structure including property and custom dimension IDs.

  • Needs authorization with the https://www.googleapis.com/auth/analytics.edit scope for successful execution.

  • Returns an empty response body upon successful archival of the CustomDimension.

Archives a CustomDimension on a property.

HTTP request

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customDimensions/*}:archive

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/analytics.edit