Method: properties.customDimensions.archive

  • Archives a CustomDimension on a property using a POST request to a specific URL containing the property and custom dimension name.

  • The request requires a path parameter name specifying the CustomDimension to archive in the format properties/*/customDimensions/*.

  • The request body must be empty.

  • The response body is an empty JSON object upon success.

  • This operation requires the https://www.googleapis.com/auth/analytics.edit OAuth scope for authorization.

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