Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
DataRetentionSettings
Stay organized with collections
Save and categorize content based on your preferences.
Settings values for data retention. This is a singleton resource.
| JSON representation |
{
"name": string,
"eventDataRetention": enum (RetentionDuration),
"userDataRetention": enum (RetentionDuration),
"resetUserDataOnNewActivity": boolean
} |
| Fields |
name |
string
Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
|
eventDataRetention |
enum (RetentionDuration)
Required. The length of time that event-level data is retained.
|
userDataRetention |
enum (RetentionDuration)
Required. The length of time that user-level data is retained.
|
resetUserDataOnNewActivity |
boolean
If true, reset the retention period for the user identifier with every event from that user.
|
RetentionDuration
Valid values for the data retention duration.
| Enums |
RETENTION_DURATION_UNSPECIFIED |
Data retention time duration is not specified. |
TWO_MONTHS |
The data retention time duration is 2 months. |
FOURTEEN_MONTHS |
The data retention time duration is 14 months. |
TWENTY_SIX_MONTHS |
The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. |
THIRTY_EIGHT_MONTHS |
The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. |
FIFTY_MONTHS |
The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. |
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\u003eData Retention Settings control how long event-level data is stored for a Google Analytics 4 property and are configured as a singleton resource.\u003c/p\u003e\n"],["\u003cp\u003eYou can set the retention duration for event data to 2, 14, 26, 38, or 50 months, with longer durations available for 360 properties.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresetUserDataOnNewActivity\u003c/code\u003e setting determines whether the user identifier retention period resets with each new event.\u003c/p\u003e\n"],["\u003cp\u003eData Retention Settings use a JSON representation and include fields for name, event data retention duration, and user data reset behavior.\u003c/p\u003e\n"]]],["Data retention settings are managed through a singleton resource, defining the duration for retaining event-level and user-level data. Key actions include setting `eventDataRetention` and `userDataRetention` using enumerated values like `TWO_MONTHS`, `FOURTEEN_MONTHS`, `TWENTY_SIX_MONTHS`, `THIRTY_EIGHT_MONTHS`, or `FIFTY_MONTHS`. Another key action is the definition of the reset retention period for each new activity with `resetUserDataOnNewActivity`. The name of the resource is a string value with the format `properties/{property}/dataRetentionSettings`.\n"],null,["# DataRetentionSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [RetentionDuration](#RetentionDuration)\n\nSettings values for data retention. This is a singleton resource.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"eventDataRetention\": enum (/analytics/devguides/config/admin/v1/rest/v1beta/DataRetentionSettings#RetentionDuration), \"userDataRetention\": enum (/analytics/devguides/config/admin/v1/rest/v1beta/DataRetentionSettings#RetentionDuration), \"resetUserDataOnNewActivity\": boolean } ``` |\n\n| Fields ||\n|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings |\n| `eventDataRetention` | `enum (`[RetentionDuration](/analytics/devguides/config/admin/v1/rest/v1beta/DataRetentionSettings#RetentionDuration)`)` Required. The length of time that event-level data is retained. |\n| `userDataRetention` | `enum (`[RetentionDuration](/analytics/devguides/config/admin/v1/rest/v1beta/DataRetentionSettings#RetentionDuration)`)` Required. The length of time that user-level data is retained. |\n| `resetUserDataOnNewActivity` | `boolean` If true, reset the retention period for the user identifier with every event from that user. |\n\nRetentionDuration\n-----------------\n\nValid values for the data retention duration.\n\n| Enums ||\n|----------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| `RETENTION_DURATION_UNSPECIFIED` | Data retention time duration is not specified. |\n| `TWO_MONTHS` | The data retention time duration is 2 months. |\n| `FOURTEEN_MONTHS` | The data retention time duration is 14 months. |\n| `TWENTY_SIX_MONTHS` | The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. |\n| `THIRTY_EIGHT_MONTHS` | The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. |\n| `FIFTY_MONTHS` | The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. |"]]
