Method: properties.customDimensions.archive

AI-generated Key Takeaways

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

• Requires an HTTP POST request to the designated endpoint with the CustomDimension's resource name.

• The request body should be empty, and upon successful completion, the response body will also be empty.

• Users need to have the analytics.edit OAuth scope to perform this action.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• Try it!

Archives a CustomDimension on a property.

HTTP request

POST https://analyticsadmin.googleapis.com/v1beta/{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