Method: properties.updateDataRetentionSettings

Stay organized with collections Save and categorize content based on your preferences.

Updates the singleton data retention settings for this property.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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

Query parameters


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: