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 Google Analytics 4 properties retain event-level data and offer options ranging from 2 to 50 months.\u003c/p\u003e\n"],["\u003cp\u003eThese settings include the ability to reset user data retention periods with each new event.\u003c/p\u003e\n"],["\u003cp\u003eThis is a singleton resource, meaning there's only one Data Retention Settings configuration per Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003e360 properties have access to extended retention durations of 26, 38, and 50 months.\u003c/p\u003e\n"]]],["Data retention settings are defined using a JSON structure. Key settings include `eventDataRetention` and `userDataRetention`, which specify the duration for retaining event-level and user-level data, respectively, using predefined enum values (like `TWO_MONTHS` or `FOURTEEN_MONTHS`). An additional setting, `resetUserDataOnNewActivity`, determines if the retention period resets with each new user event. 360 properties have access to extended periods like 26, 38 or 50 months for event data.\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/v1alpha/DataRetentionSettings#RetentionDuration), \"userDataRetention\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/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/v1alpha/DataRetentionSettings#RetentionDuration)`)` Required. The length of time that event-level data is retained. |\n| `userDataRetention` | `enum (`[RetentionDuration](/analytics/devguides/config/admin/v1/rest/v1alpha/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. |"]]
