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/v1alpha/{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 for the soft deletion of a Google Analytics 4 property, essentially moving it to the trash."],["Soft-deleted properties and their associated resources are permanently deleted after a period; they can be restored before that time via the Trash Can UI."],["The API requires a DELETE request with the property ID specified in the path, and an empty request body."],["Upon successful execution, the API returns the soft-deleted Property object in the response body."],["To use this API, you need the `https://www.googleapis.com/auth/analytics.edit` OAuth scope."]]],["This API soft-deletes a specified property identified by its name (e.g., \"properties/1000\") via a `DELETE` HTTP request. The request body must be empty. Upon success, it returns the soft-deleted Property. Soft-deleted properties can be restored through the Trash Can UI but will be permanently purged if not restored before their expiration time. The required authorization scope is `https://www.googleapis.com/auth/analytics.edit`. An error is returned if the property is not found.\n"]]
