Method: properties.updateDataRetentionSettings

  • This endpoint updates the data retention settings for a Google Analytics 4 property using an HTTP PATCH request.

  • It requires specifying the dataRetentionSettings.name as a path parameter to identify the property's settings.

  • An updateMask query parameter is required to indicate which fields should be updated within the data retention settings.

  • The request body should contain the updated DataRetentionSettings object, and a successful response will return the updated settings.

  • Users need the https://www.googleapis.com/auth/analytics.edit OAuth scope to authorize this request.

Updates the singleton data retention settings for this property.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataRetentionSettings.name

string

Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of DataRetentionSettings.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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