Method: properties.delete

  • Marks a Google Analytics Property as soft-deleted ("trashed") and returns it.

  • Soft-deleted properties can be restored using the Trash Can UI, but not through this API method.

  • Properties and their child resources will be permanently purged if not restored before the expiration time.

  • Returns an error if the specified Property is not found.

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 usesgRPC 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 ofProperty.

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 theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-01-14 UTC.