Method: properties.updateDataRetentionSettings

  • This API allows you to update the data retention settings for a specific property.

  • The update is performed using an HTTP PATCH request to a specified URL that includes the property's resource name.

  • The request requires an updateMask query parameter to specify which fields of the data retention settings should be updated.

  • The request and response bodies contain an instance of the DataRetentionSettings resource.

  • Access to this API requires the https://www.googleapis.com/auth/analytics.edit OAuth scope.

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