delete method

Future<GoogleAnalyticsAdminV1alphaProperty> delete(
  1. String name, {
  2. String? $fields,
})

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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.

Request parameters:

name - Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000" Value must have pattern ^properties/\[^/\]+$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleAnalyticsAdminV1alphaProperty.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleAnalyticsAdminV1alphaProperty> delete(
  core.String name, {
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1alpha/' + core.Uri.encodeFull('$name');

  final _response = await _requester.request(
    _url,
    'DELETE',
    queryParams: _queryParams,
  );
  return GoogleAnalyticsAdminV1alphaProperty.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}