analyticsadmin.properties.updateDataRetentionSettings
Update a Google Analytics property's data retention settings to change event and user data retention periods and reset-user-data behavior via PATCH.
Instructions
Updates the singleton data retention settings for this property [HTTP PATCH] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaDataRetentionSettings object accepting eventDataRetention, name, resetUserDataOnNewActivity, userDataRetention; pass it via params or whole via body_file Siblings over the same resource: acknowledgeUserDataCollection, create, delete, get, getDataRetentionSettings, list, patch, runAccessReport.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | [URL path segment] Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings | |
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaDataRetentionSettings object. | |
| updateMask | No | [query parameter] 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 enti | |
| request_body | No | Request body of type GoogleAnalyticsAdminV1betaDataRetentionSettings: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| userDataRetention | No | ||
| eventDataRetention | No | ||
| resetUserDataOnNewActivity | No |