Reference documentation and code samples for the Google Analytics Admin V1beta Client class DataRetentionSettings.
Settings values for data retention. This is a singleton resource.
Generated from protobuf message google.analytics.admin.v1beta.DataRetentionSettings
Namespace
Google \ Analytics \ Admin \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings |
↳ event_data_retention |
int
Required. The length of time that event-level data is retained. |
↳ user_data_retention |
int
Required. The length of time that user-level data is retained. |
↳ reset_user_data_on_new_activity |
bool
If true, reset the retention period for the user identifier with every event from that user. |
getName
Output only. Resource name for this DataRetentionSetting resource.
Format: properties/{property}/dataRetentionSettings
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Resource name for this DataRetentionSetting resource.
Format: properties/{property}/dataRetentionSettings
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventDataRetention
Required. The length of time that event-level data is retained.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type RetentionDuration. |
setEventDataRetention
Required. The length of time that event-level data is retained.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type RetentionDuration. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUserDataRetention
Required. The length of time that user-level data is retained.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type RetentionDuration. |
setUserDataRetention
Required. The length of time that user-level data is retained.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type RetentionDuration. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResetUserDataOnNewActivity
If true, reset the retention period for the user identifier with every event from that user.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setResetUserDataOnNewActivity
If true, reset the retention period for the user identifier with every event from that user.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|