Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.delete
Stay organized with collections
Save and categorize content based on your preferences.
Marks target Property as soft-deleted (ie: "trashed") and returns it.
This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.
If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772
Returns an error if the target is not found.
HTTP request
DELETE https://analyticsadmin.googleapis.com/v1beta/{name=properties/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Property.
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\u003eThis API allows you to mark a Google Analytics 4 property as soft-deleted, essentially moving it to the trash.\u003c/p\u003e\n"],["\u003cp\u003eSoft-deleted properties can be restored through the Trash Can UI before they are permanently purged.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires a \u003ccode\u003eDELETE\u003c/code\u003e request with the property ID specified in the path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is necessary, and a successful deletion returns the \u003ccode\u003eProperty\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, you need the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e authorization scope.\u003c/p\u003e\n"]]],["This API marks a Property as soft-deleted via a DELETE HTTP request to `https://analyticsadmin.googleapis.com/v1beta/{name=properties/*}`. The `name` path parameter, in the format \"properties/{property_id}\", specifies the target Property. The request body must be empty. A successful operation returns the deleted Property. Soft-deleted properties can be restored via the Trash Can UI, and permanently purged after expiration. Authorization requires the `https://www.googleapis.com/auth/analytics.edit` scope. An error is returned if the property is not found.\n"],null,["# Method: properties.delete\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\nMarks target Property as soft-deleted (ie: \"trashed\") and returns it.\n\nThis API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI.\n\nIf the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. \u003chttps://support.google.com/analytics/answer/6154772\u003e\n\nReturns an error if the target is not found.\n\n### HTTP request\n\n`DELETE https://analyticsadmin.googleapis.com/v1beta/{name=properties/*}`\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 Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Property](/analytics/devguides/config/admin/v1/rest/v1beta/properties#Property).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
