Method: properties.getDataRetentionSettings

  • Retrieve data retention settings for a specific Google Analytics 4 property using an HTTP GET request.

  • The request URL requires a property ID and utilizes gRPC Transcoding syntax.

  • An empty request body is necessary, while a successful response returns a DataRetentionSettings object.

  • Authorization requires specific OAuth scopes for either read-only or edit access to Analytics data.

Returns the singleton data retention settings for this property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1beta/{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