blob: c69169d49b662a7148506678133b8f573b5b6561 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="analyticsadmin_v1alpha.properties.androidAppDataStreams.html">androidAppDataStreams()</a></code>
79</p>
80<p class="firstline">Returns the androidAppDataStreams Resource.</p>
81
82<p class="toc_element">
yoshi-code-botc2cd3262021-05-16 02:16:04 -070083 <code><a href="analyticsadmin_v1alpha.properties.conversionEvents.html">conversionEvents()</a></code>
84</p>
85<p class="firstline">Returns the conversionEvents Resource.</p>
86
87<p class="toc_element">
88 <code><a href="analyticsadmin_v1alpha.properties.customDimensions.html">customDimensions()</a></code>
89</p>
90<p class="firstline">Returns the customDimensions Resource.</p>
91
92<p class="toc_element">
93 <code><a href="analyticsadmin_v1alpha.properties.customMetrics.html">customMetrics()</a></code>
94</p>
95<p class="firstline">Returns the customMetrics Resource.</p>
96
97<p class="toc_element">
yoshi-code-bot07708072021-07-20 00:20:24 -070098 <code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html">displayVideo360AdvertiserLinkProposals()</a></code>
99</p>
100<p class="firstline">Returns the displayVideo360AdvertiserLinkProposals Resource.</p>
101
102<p class="toc_element">
103 <code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html">displayVideo360AdvertiserLinks()</a></code>
104</p>
105<p class="firstline">Returns the displayVideo360AdvertiserLinks Resource.</p>
106
107<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700108 <code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
109</p>
110<p class="firstline">Returns the firebaseLinks Resource.</p>
111
112<p class="toc_element">
113 <code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
114</p>
115<p class="firstline">Returns the googleAdsLinks Resource.</p>
116
117<p class="toc_element">
118 <code><a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams()</a></code>
119</p>
120<p class="firstline">Returns the iosAppDataStreams Resource.</p>
121
122<p class="toc_element">
123 <code><a href="analyticsadmin_v1alpha.properties.userLinks.html">userLinks()</a></code>
124</p>
125<p class="firstline">Returns the userLinks Resource.</p>
126
127<p class="toc_element">
128 <code><a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams()</a></code>
129</p>
130<p class="firstline">Returns the webDataStreams Resource.</p>
131
132<p class="toc_element">
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700133 <code><a href="#acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</a></code></p>
134<p class="firstline">Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.</p>
135<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700136 <code><a href="#close">close()</a></code></p>
137<p class="firstline">Close httplib2 connections.</p>
138<p class="toc_element">
139 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700140<p class="firstline">Creates an "GA4" property with the specified location and attributes.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700141<p class="toc_element">
142 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700143<p class="firstline">Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144<p class="toc_element">
145 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800146<p class="firstline">Lookup for a single "GA4" Property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147<p class="toc_element">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700148 <code><a href="#getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</a></code></p>
149<p class="firstline">Returns the singleton data retention settings for this property.</p>
150<p class="toc_element">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700151 <code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
152<p class="firstline">Lookup for Google Signals settings for a property.</p>
153<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800154 <code><a href="#list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700155<p class="firstline">Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156<p class="toc_element">
157 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
158<p class="firstline">Retrieves the next page of results.</p>
159<p class="toc_element">
160 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
161<p class="firstline">Updates a property.</p>
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700162<p class="toc_element">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700163 <code><a href="#updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
164<p class="firstline">Updates the singleton data retention settings for this property.</p>
165<p class="toc_element">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700166 <code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
167<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700168<h3>Method Details</h3>
169<div class="method">
yoshi-code-bot1c9dcfd2021-10-12 00:20:31 -0700170 <code class="details" id="acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</code>
171 <pre>Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or via this API) before MeasurementProtocolSecret resources may be created.
172
173Args:
174 property: string, Required. The property for which to acknowledge user data collection. (required)
175 body: object, The request body.
176 The object takes the form of:
177
178{ # Request message for AcknowledgeUserDataCollection RPC.
179 &quot;acknowledgement&quot;: &quot;A String&quot;, # Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: &quot;I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property.&quot;
180}
181
182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187Returns:
188 An object of the form:
189
190 { # Response message for AcknowledgeUserDataCollection RPC.
191}</pre>
192</div>
193
194<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700195 <code class="details" id="close">close()</code>
196 <pre>Close httplib2 connections.</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700201 <pre>Creates an &quot;GA4&quot; property with the specified location and attributes.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700202
203Args:
204 body: object, The request body.
205 The object takes the form of:
206
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700207{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700208 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800209 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400211 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800212 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400213 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800214 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
215 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800216 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700217 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700218 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800219 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800220}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700221
222 x__xgafv: string, V1 error format.
223 Allowed values
224 1 - v1 error format
225 2 - v2 error format
226
227Returns:
228 An object of the form:
229
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700230 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700231 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800232 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
233 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400234 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800235 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400236 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800237 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
238 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
239 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700240 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700241 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800242 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
243}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244</div>
245
246<div class="method">
247 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700248 <pre>Marks target Property as soft-deleted (ie: &quot;trashed&quot;) and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700249
250Args:
251 name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400260 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700261 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400262 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
263 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
264 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
265 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
266 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
267 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
268 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
269 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700270 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400271 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
272 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800273}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274</div>
275
276<div class="method">
277 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800278 <pre>Lookup for a single &quot;GA4&quot; Property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700279
280Args:
281 name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
282 x__xgafv: string, V1 error format.
283 Allowed values
284 1 - v1 error format
285 2 - v2 error format
286
287Returns:
288 An object of the form:
289
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700290 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700291 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800292 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
293 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400294 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800295 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400296 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800297 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
298 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
299 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700300 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700301 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
303}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700304</div>
305
306<div class="method">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700307 <code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
308 <pre>Returns the singleton data retention settings for this property.
309
310Args:
311 name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: &quot;properties/1000/dataRetentionSettings&quot; (required)
312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317Returns:
318 An object of the form:
319
320 { # Settings values for data retention. This is a singleton resource.
321 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
322 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
323 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
324}</pre>
325</div>
326
327<div class="method">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700328 <code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
329 <pre>Lookup for Google Signals settings for a property.
330
331Args:
332 name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
341 { # Settings values for Google Signals. This is a singleton resource.
342 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
343 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot;
344 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
345}</pre>
346</div>
347
348<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800349 <code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700350 <pre>Returns child Properties under the specified parent Account. Only &quot;GA4&quot; properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: &quot;trashed&quot;) properties are excluded by default. Returns an empty list if no relevant properties are found.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700351
352Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800353 filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800354 pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
355 pageToken: string, A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800356 showDeleted: boolean, Whether to include soft-deleted (ie: &quot;trashed&quot;) Properties in the results. Properties can be inspected to determine whether they are deleted or not.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700357 x__xgafv: string, V1 error format.
358 Allowed values
359 1 - v1 error format
360 2 - v2 error format
361
362Returns:
363 An object of the form:
364
365 { # Response message for ListProperties RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800366 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
367 &quot;properties&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
368 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700369 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800370 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
371 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400372 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800373 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400374 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800375 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
376 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
377 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700378 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700379 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800380 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
381 },
382 ],
383}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700384</div>
385
386<div class="method">
387 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
388 <pre>Retrieves the next page of results.
389
390Args:
391 previous_request: The request for the previous page. (required)
392 previous_response: The response from the request for the previous page. (required)
393
394Returns:
395 A request object that you can call &#x27;execute()&#x27; on to request the next
396 page. Returns None if there are no more items in the collection.
397 </pre>
398</div>
399
400<div class="method">
401 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
402 <pre>Updates a property.
403
404Args:
405 name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
406 body: object, The request body.
407 The object takes the form of:
408
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700409{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700410 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800411 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800412 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400413 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800414 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400415 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800416 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
417 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800418 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700419 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700420 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800421 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800422}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700423
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800424 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700425 x__xgafv: string, V1 error format.
426 Allowed values
427 1 - v1 error format
428 2 - v2 error format
429
430Returns:
431 An object of the form:
432
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700433 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700434 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800435 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
436 &quot;currencyCode&quot;: &quot;A String&quot;, # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: &quot;USD&quot;, &quot;EUR&quot;, &quot;JPY&quot;
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400437 &quot;deleteTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800438 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400439 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800440 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
441 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
442 &quot;parent&quot;: &quot;A String&quot;, # Immutable. Resource name of this property&#x27;s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: &quot;accounts/100&quot;
yoshi-code-bot1a4514d2021-07-13 00:20:24 -0700443 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700444 &quot;timeZone&quot;: &quot;A String&quot;, # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: &quot;America/Los_Angeles&quot;
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800445 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
446}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700447</div>
448
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700449<div class="method">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700450 <code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
451 <pre>Updates the singleton data retention settings for this property.
452
453Args:
454 name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
455 body: object, The request body.
456 The object takes the form of:
457
458{ # Settings values for data retention. This is a singleton resource.
459 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
460 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
461 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
462}
463
464 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.
465 x__xgafv: string, V1 error format.
466 Allowed values
467 1 - v1 error format
468 2 - v2 error format
469
470Returns:
471 An object of the form:
472
473 { # Settings values for data retention. This is a singleton resource.
474 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
475 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
476 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
477}</pre>
478</div>
479
480<div class="method">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700481 <code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
482 <pre>Updates Google Signals settings for a property.
483
484Args:
485 name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot; (required)
486 body: object, The request body.
487 The object takes the form of:
488
489{ # Settings values for Google Signals. This is a singleton resource.
490 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
491 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot;
492 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
493}
494
495 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.
496 x__xgafv: string, V1 error format.
497 Allowed values
498 1 - v1 error format
499 2 - v2 error format
500
501Returns:
502 An object of the form:
503
504 { # Settings values for Google Signals. This is a singleton resource.
505 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
506 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot;
507 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
508}</pre>
509</div>
510
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700511</body></html>