Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customDimensions.archive
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["\u003cp\u003eArchives a specified CustomDimension associated with a Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and uses the \u003ccode\u003ePOST\u003c/code\u003e method with a specific URL structure including property and custom dimension IDs.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e scope for successful execution.\u003c/p\u003e\n"],["\u003cp\u003eReturns an empty response body upon successful archival of the CustomDimension.\u003c/p\u003e\n"]]],["This document outlines how to archive a CustomDimension. The key action is sending a `POST` request to the specified URL: `https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customDimensions/*}:archive`. The `name` path parameter, a string, is required to identify the CustomDimension. The request body should be empty. A successful request returns an empty JSON object in the response body. The process requires the `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"],null,["# Method: properties.customDimensions.archive\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nArchives a CustomDimension on a property.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customDimensions/*}:archive`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
