Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audiences.archive
Stay organized with collections
Save and categorize content based on your preferences.
Archives an Audience on a property.
HTTP request
POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}:archive
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. Example format: properties/1234/audiences/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 an Audience on a specified Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns an empty response body upon successful completion.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003ePOST\u003c/code\u003e method with the URL format: \u003ccode\u003ehttps://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}:archive\u003c/code\u003e, where \u003ccode\u003e{name}\u003c/code\u003e represents the property and audience IDs.\u003c/p\u003e\n"],["\u003cp\u003eNeeds the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["The core function is archiving an Audience on a property via a POST request to a specific URL: `https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}:archive`. The required `name` path parameter identifies the Audience to be archived (e.g., `properties/1234/audiences/5678`). The request body must be empty, and a successful response returns an empty JSON object. The `analytics.edit` OAuth scope is required for authorization.\n"],null,["# Method: properties.audiences.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 an Audience on a property.\n\n### HTTP request\n\n`POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/audiences/*}: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. Example format: properties/1234/audiences/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`"]]