AI-generated Key Takeaways
-
This API request soft-deletes a specified Google Analytics 4 account, essentially moving it to the trash.
-
Soft-deleted accounts and their associated data are permanently deleted after a certain time period, unless restored through the Trash Can UI.
-
The request requires the
analytics.edit
scope for authorization and uses aDELETE
request with the account name as a path parameter. -
There's no specific API method to restore deleted accounts; restoration is handled via the Google Analytics UI.
-
If the targeted account is not found, the request will return an error.
Marks target Account as soft-deleted (ie: "trashed") and returns it.
This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI.
If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, 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=accounts/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" |
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