Method: properties.customMetrics.archive
Archives a CustomMetric on a property.
HTTP request
POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customMetrics/*}:archive
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/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."],[[["Archives a specific CustomMetric associated with a Google Analytics 4 property."],["Requires an HTTP POST request to a formatted URL including the property and custom metric IDs."],["Uses an empty request body and returns an empty response body upon successful archival."],["Needs authorization with the `https://www.googleapis.com/auth/analytics.edit` scope."]]],["This document outlines how to archive a CustomMetric within a property using a POST request. The core action is initiated via a specific URL (`POST https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/customMetrics/*}:archive`), where the `name` parameter, representing the CustomMetric's identifier, is required within the path. The request body must be empty and the response upon successful completion is an empty JSON object. This operation mandates the `https://www.googleapis.com/auth/analytics.edit` authorization scope.\n"]]
