Method: properties.updateDataRetentionSettings
Updates the singleton data retention settings for this property.
HTTP request
PATCH https://analyticsadmin.googleapis.com/v1beta/{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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-14 UTC.
[null,null,["Last updated 2025-01-14 UTC."],[[["This method updates the data retention settings for a Google Analytics 4 property using an HTTP PATCH request."],["It requires specifying the property in the path parameter and uses a field mask in the query parameter to indicate which fields should be updated."],["The request body should contain the desired DataRetentionSettings, and a successful response will return the updated settings."],["Authorization with the `https://www.googleapis.com/auth/analytics.edit` scope is necessary to use this method."]]],["This document details updating data retention settings for a property using a `PATCH` request to a specified URL. The URL includes a path parameter, `dataRetentionSettings.name`, indicating the resource to be updated. The `updateMask` query parameter specifies which fields to modify. The request and response bodies use the `DataRetentionSettings` format. The process requires authorization via the `https://www.googleapis.com/auth/analytics.edit` OAuth scope. It also supports the `Try it!` function.\n"]]
