Method: properties.delete
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."],[[["This API allows you to mark a Google Analytics 4 property as soft-deleted, essentially moving it to the trash."],["Soft-deleted properties can be restored through the Trash Can UI before they are permanently purged."],["The API requires a `DELETE` request with the property ID specified in the path parameter."],["An empty request body is necessary, and a successful deletion returns the `Property` object."],["To use this API, you need the `https://www.googleapis.com/auth/analytics.edit` authorization scope."]]],["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"]]
