Skip to content

Commit 8e0c67f

Browse files
yoshi-automationyoshi-automation
committed
feat(analyticsadmin): update the api
#### analyticsadmin:v1alpha The following keys were added: - resources.properties.methods.getDataRetentionSettings (Total Keys: 11) - resources.properties.methods.updateDataRetentionSettings (Total Keys: 15) - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.dataRetentionSettings.$ref (Total Keys: 1) - schemas.GoogleAnalyticsAdminV1alphaDataRetentionSettings (Total Keys: 6)
1 parent f47b851 commit 8e0c67f

File tree

3 files changed

+173
-3
lines changed

3 files changed

+173
-3
lines changed

‎docs/dyn/analyticsadmin_v1alpha.accounts.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,11 @@ <h3>Method Details</h3>
379379
&quot;parameterName&quot;: &quot;A String&quot;, # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
380380
&quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. The scope of this custom metric.
381381
},
382+
&quot;dataRetentionSettings&quot;: { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
383+
&quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
384+
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
385+
&quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
386+
},
382387
&quot;displayVideo360AdvertiserLink&quot;: { # A link between a GA4 property and a Display &amp; Video 360 advertiser. # A snapshot of a DisplayVideo360AdvertiserLink resource in change history.
383388
&quot;adsPersonalizationEnabled&quot;: True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
384389
&quot;advertiserDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the Display &amp; Video 360 Advertiser.
@@ -496,6 +501,11 @@ <h3>Method Details</h3>
496501
&quot;parameterName&quot;: &quot;A String&quot;, # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
497502
&quot;scope&quot;: &quot;A String&quot;, # Required. Immutable. The scope of this custom metric.
498503
},
504+
&quot;dataRetentionSettings&quot;: { # Settings values for data retention. This is a singleton resource. # A snapshot of a data retention settings resource in change history.
505+
&quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
506+
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
507+
&quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
508+
},
499509
&quot;displayVideo360AdvertiserLink&quot;: { # A link between a GA4 property and a Display &amp; Video 360 advertiser. # A snapshot of a DisplayVideo360AdvertiserLink resource in change history.
500510
&quot;adsPersonalizationEnabled&quot;: True or False, # Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.
501511
&quot;advertiserDisplayName&quot;: &quot;A String&quot;, # Output only. The display name of the Display &amp; Video 360 Advertiser.

‎docs/dyn/analyticsadmin_v1alpha.properties.html

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,9 @@ <h2>Instance Methods</h2>
141141
<p class="toc_element">
142142
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
143143
<p class="firstline">Lookup for a single "GA4" Property.</p>
144+
<p class="toc_element">
145+
<code><a href="#getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</a></code></p>
146+
<p class="firstline">Returns the singleton data retention settings for this property.</p>
144147
<p class="toc_element">
145148
<code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
146149
<p class="firstline">Lookup for Google Signals settings for a property.</p>
@@ -153,6 +156,9 @@ <h2>Instance Methods</h2>
153156
<p class="toc_element">
154157
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
155158
<p class="firstline">Updates a property.</p>
159+
<p class="toc_element">
160+
<code><a href="#updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
161+
<p class="firstline">Updates the singleton data retention settings for this property.</p>
156162
<p class="toc_element">
157163
<code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
158164
<p class="firstline">Updates Google Signals settings for a property.</p>
@@ -265,6 +271,27 @@ <h3>Method Details</h3>
265271
}</pre>
266272
</div>
267273

274+
<div class="method">
275+
<code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
276+
<pre>Returns the singleton data retention settings for this property.
277+
278+
Args:
279+
name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: &quot;properties/1000/dataRetentionSettings&quot; (required)
280+
x__xgafv: string, V1 error format.
281+
Allowed values
282+
1 - v1 error format
283+
2 - v2 error format
284+
285+
Returns:
286+
An object of the form:
287+
288+
{ # Settings values for data retention. This is a singleton resource.
289+
&quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
290+
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
291+
&quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
292+
}</pre>
293+
</div>
294+
268295
<div class="method">
269296
<code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
270297
<pre>Lookup for Google Signals settings for a property.
@@ -384,6 +411,37 @@ <h3>Method Details</h3>
384411
}</pre>
385412
</div>
386413

414+
<div class="method">
415+
<code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
416+
<pre>Updates the singleton data retention settings for this property.
417+
418+
Args:
419+
name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
420+
body: object, The request body.
421+
The object takes the form of:
422+
423+
{ # Settings values for data retention. This is a singleton resource.
424+
&quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
425+
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
426+
&quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
427+
}
428+
429+
updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
430+
x__xgafv: string, V1 error format.
431+
Allowed values
432+
1 - v1 error format
433+
2 - v2 error format
434+
435+
Returns:
436+
An object of the form:
437+
438+
{ # Settings values for data retention. This is a singleton resource.
439+
&quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
440+
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
441+
&quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
442+
}</pre>
443+
</div>
444+
387445
<div class="method">
388446
<code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
389447
<pre>Updates Google Signals settings for a property.

‎googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json

Lines changed: 105 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -711,6 +711,32 @@
711711
"https://www.googleapis.com/auth/analytics.readonly"
712712
]
713713
},
714+
"getDataRetentionSettings": {
715+
"description": "Returns the singleton data retention settings for this property.",
716+
"flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings",
717+
"httpMethod": "GET",
718+
"id": "analyticsadmin.properties.getDataRetentionSettings",
719+
"parameterOrder": [
720+
"name"
721+
],
722+
"parameters": {
723+
"name": {
724+
"description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"",
725+
"location": "path",
726+
"pattern": "^properties/[^/]+/dataRetentionSettings$",
727+
"required": true,
728+
"type": "string"
729+
}
730+
},
731+
"path": "v1alpha/{+name}",
732+
"response": {
733+
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
734+
},
735+
"scopes": [
736+
"https://www.googleapis.com/auth/analytics.edit",
737+
"https://www.googleapis.com/auth/analytics.readonly"
738+
]
739+
},
714740
"getGoogleSignalsSettings": {
715741
"description": "Lookup for Google Signals settings for a property.",
716742
"flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings",
@@ -809,6 +835,40 @@
809835
"https://www.googleapis.com/auth/analytics.edit"
810836
]
811837
},
838+
"updateDataRetentionSettings": {
839+
"description": "Updates the singleton data retention settings for this property.",
840+
"flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings",
841+
"httpMethod": "PATCH",
842+
"id": "analyticsadmin.properties.updateDataRetentionSettings",
843+
"parameterOrder": [
844+
"name"
845+
],
846+
"parameters": {
847+
"name": {
848+
"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings",
849+
"location": "path",
850+
"pattern": "^properties/[^/]+/dataRetentionSettings$",
851+
"required": true,
852+
"type": "string"
853+
},
854+
"updateMask": {
855+
"description": "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.",
856+
"format": "google-fieldmask",
857+
"location": "query",
858+
"type": "string"
859+
}
860+
},
861+
"path": "v1alpha/{+name}",
862+
"request": {
863+
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
864+
},
865+
"response": {
866+
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings"
867+
},
868+
"scopes": [
869+
"https://www.googleapis.com/auth/analytics.edit"
870+
]
871+
},
812872
"updateGoogleSignalsSettings": {
813873
"description": "Updates Google Signals settings for a property.",
814874
"flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings",
@@ -3092,7 +3152,7 @@
30923152
}
30933153
}
30943154
},
3095-
"revision": "20210813",
3155+
"revision": "20210822",
30963156
"rootUrl": "https://analyticsadmin.googleapis.com/",
30973157
"schemas": {
30983158
"GoogleAnalyticsAdminV1alphaAccount": {
@@ -3440,6 +3500,10 @@
34403500
"$ref": "GoogleAnalyticsAdminV1alphaCustomMetric",
34413501
"description": "A snapshot of a CustomMetric resource in change history."
34423502
},
3503+
"dataRetentionSettings": {
3504+
"$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings",
3505+
"description": "A snapshot of a data retention settings resource in change history."
3506+
},
34433507
"displayVideo360AdvertiserLink": {
34443508
"$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink",
34453509
"description": "A snapshot of a DisplayVideo360AdvertiserLink resource in change history."
@@ -3685,6 +3749,42 @@
36853749
},
36863750
"type": "object"
36873751
},
3752+
"GoogleAnalyticsAdminV1alphaDataRetentionSettings": {
3753+
"description": "Settings values for data retention. This is a singleton resource.",
3754+
"id": "GoogleAnalyticsAdminV1alphaDataRetentionSettings",
3755+
"properties": {
3756+
"eventDataRetention": {
3757+
"description": "The length of time that event-level data is retained.",
3758+
"enum": [
3759+
"RETENTION_DURATION_UNSPECIFIED",
3760+
"TWO_MONTHS",
3761+
"FOURTEEN_MONTHS",
3762+
"TWENTY_SIX_MONTHS",
3763+
"THIRTY_EIGHT_MONTHS",
3764+
"FIFTY_MONTHS"
3765+
],
3766+
"enumDescriptions": [
3767+
"Data retention time duration is not specified.",
3768+
"The data retention time duration is 2 months.",
3769+
"The data retention time duration is 14 months.",
3770+
"The data retention time duration is 26 months. Available to 360 properties only.",
3771+
"The data retention time duration is 38 months. Available to 360 properties only.",
3772+
"The data retention time duration is 50 months. Available to 360 properties only."
3773+
],
3774+
"type": "string"
3775+
},
3776+
"name": {
3777+
"description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings",
3778+
"readOnly": true,
3779+
"type": "string"
3780+
},
3781+
"resetUserDataOnNewActivity": {
3782+
"description": "If true, reset the retention period for the user identifier with every event from that user.",
3783+
"type": "boolean"
3784+
}
3785+
},
3786+
"type": "object"
3787+
},
36883788
"GoogleAnalyticsAdminV1alphaDataSharingSettings": {
36893789
"description": "A resource message representing data sharing settings of a Google Analytics account.",
36903790
"id": "GoogleAnalyticsAdminV1alphaDataSharingSettings",
@@ -4599,7 +4699,8 @@
45994699
"CONVERSION_EVENT",
46004700
"MEASUREMENT_PROTOCOL_SECRET",
46014701
"CUSTOM_DIMENSION",
4602-
"CUSTOM_METRIC"
4702+
"CUSTOM_METRIC",
4703+
"DATA_RETENTION_SETTINGS"
46034704
],
46044705
"enumDescriptions": [
46054706
"Resource type unknown or not specified.",
@@ -4614,7 +4715,8 @@
46144715
"ConversionEvent resource",
46154716
"MeasurementProtocolSecret resource",
46164717
"CustomDimension resource",
4617-
"CustomMetric resource"
4718+
"CustomMetric resource",
4719+
"DataRetentionSettings resource"
46184720
],
46194721
"type": "string"
46204722
},

0 commit comments

Comments
 (0)