Method: properties.getDataRetentionSettings

  • Retrieves the data retention settings for a specific Google Analytics 4 property.

  • Uses an HTTP GET request with the property ID specified in the path parameter.

  • Requires authentication with appropriate OAuth scopes for read or edit access to Analytics data.

  • Returns a DataRetentionSettings object containing the property's data retention configuration upon successful execution.

  • Request body should be empty.

Returns the singleton data retention settings for this property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/dataRetentionSettings}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of DataRetentionSettings.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit