Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
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
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
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-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eThis endpoint updates the data retention settings for a Google Analytics 4 property using an HTTP PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eIt requires specifying the \u003ccode\u003edataRetentionSettings.name\u003c/code\u003e as a path parameter to identify the property's settings.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eupdateMask\u003c/code\u003e query parameter is required to indicate which fields should be updated within the data retention settings.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain the updated \u003ccode\u003eDataRetentionSettings\u003c/code\u003e object, and a successful response will return the updated settings.\u003c/p\u003e\n"],["\u003cp\u003eUsers need the \u003ccode\u003ehttps://www.googleapis.com/auth/analytics.edit\u003c/code\u003e OAuth scope to authorize this request.\u003c/p\u003e\n"]]],["This document details updating data retention settings for a property using a `PATCH` request to the specified URL. The resource path is defined by `dataRetentionSettings.name`, and the request requires a `updateMask` query parameter specifying fields to update. The request body contains `DataRetentionSettings`, and a successful response also returns `DataRetentionSettings`. This operation requires authorization with the `https://www.googleapis.com/auth/analytics.edit` scope. Additionally, it indicates that there are HTTP requests, path, query, request, and response bodies, and offers a 'try it!' feature.\n"],null,["# Method: properties.updateDataRetentionSettings\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the singleton data retention settings for this property.\n\n### HTTP request\n\n`PATCH https://analyticsadmin.googleapis.com/v1alpha/{dataRetentionSettings.name=properties/*/dataRetentionSettings}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `dataRetentionSettings.name` | `string` Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n\n### Request body\n\nThe request body contains an instance of [DataRetentionSettings](/analytics/devguides/config/admin/v1/rest/v1alpha/DataRetentionSettings).\n\n### Response body\n\nIf successful, the response body contains an instance of [DataRetentionSettings](/analytics/devguides/config/admin/v1/rest/v1alpha/DataRetentionSettings).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/analytics.edit`"]]
