blob: be472f875071d8162930e871bab9b611c6c24ca8 [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">
133 <code><a href="#close">close()</a></code></p>
134<p class="firstline">Close httplib2 connections.</p>
135<p class="toc_element">
136 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700137<p class="firstline">Creates an "GA4" property with the specified location and attributes.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700138<p class="toc_element">
139 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700140<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 -0700141<p class="toc_element">
142 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800143<p class="firstline">Lookup for a single "GA4" Property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144<p class="toc_element">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700145 <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>
147<p class="toc_element">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700148 <code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
149<p class="firstline">Lookup for Google Signals settings for a property.</p>
150<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 <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 -0700152<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 -0700153<p class="toc_element">
154 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
155<p class="firstline">Retrieves the next page of results.</p>
156<p class="toc_element">
157 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
158<p class="firstline">Updates a property.</p>
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700159<p class="toc_element">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700160 <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>
162<p class="toc_element">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700163 <code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
164<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700165<h3>Method Details</h3>
166<div class="method">
167 <code class="details" id="close">close()</code>
168 <pre>Close httplib2 connections.</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700173 <pre>Creates an &quot;GA4&quot; property with the specified location and attributes.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700174
175Args:
176 body: object, The request body.
177 The object takes the form of:
178
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700179{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700180 &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 -0800181 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800182 &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 -0400183 &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 -0800184 &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 -0400185 &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 -0800186 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
187 &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 -0800188 &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 -0700189 &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 -0700190 &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 -0800191 &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 -0800192}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700193
194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700202 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700203 &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 -0800204 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
205 &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 -0400206 &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 -0800207 &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 -0400208 &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 -0800209 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
210 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
211 &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 -0700212 &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 -0700213 &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 -0800214 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
215}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700216</div>
217
218<div class="method">
219 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700220 <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 -0700221
222Args:
223 name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
224 x__xgafv: string, V1 error format.
225 Allowed values
226 1 - v1 error format
227 2 - v2 error format
228
229Returns:
230 An object of the form:
231
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400232 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700233 &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 -0400234 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
235 &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;
236 &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.
237 &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.
238 &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.
239 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
240 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
241 &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 -0700242 &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 -0400243 &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;
244 &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 -0800245}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700246</div>
247
248<div class="method">
249 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800250 <pre>Lookup for a single &quot;GA4&quot; Property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700251
252Args:
253 name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700262 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700263 &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 -0800264 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
265 &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 -0400266 &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 -0800267 &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 -0400268 &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 -0800269 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
270 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
271 &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 -0700272 &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 -0700273 &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 -0800274 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
275}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700276</div>
277
278<div class="method">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700279 <code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
280 <pre>Returns the singleton data retention settings for this property.
281
282Args:
283 name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: &quot;properties/1000/dataRetentionSettings&quot; (required)
284 x__xgafv: string, V1 error format.
285 Allowed values
286 1 - v1 error format
287 2 - v2 error format
288
289Returns:
290 An object of the form:
291
292 { # Settings values for data retention. This is a singleton resource.
293 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
294 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
295 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
296}</pre>
297</div>
298
299<div class="method">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700300 <code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
301 <pre>Lookup for Google Signals settings for a property.
302
303Args:
304 name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
305 x__xgafv: string, V1 error format.
306 Allowed values
307 1 - v1 error format
308 2 - v2 error format
309
310Returns:
311 An object of the form:
312
313 { # Settings values for Google Signals. This is a singleton resource.
314 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
315 &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;
316 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
317}</pre>
318</div>
319
320<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800321 <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 -0700322 <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 -0700323
324Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800325 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 -0800326 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)
327 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 -0800328 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 -0700329 x__xgafv: string, V1 error format.
330 Allowed values
331 1 - v1 error format
332 2 - v2 error format
333
334Returns:
335 An object of the form:
336
337 { # Response message for ListProperties RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800338 &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.
339 &quot;properties&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
340 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700341 &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 -0800342 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
343 &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 -0400344 &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 -0800345 &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 -0400346 &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 -0800347 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
348 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
349 &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 -0700350 &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 -0700351 &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 -0800352 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
353 },
354 ],
355}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700356</div>
357
358<div class="method">
359 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
360 <pre>Retrieves the next page of results.
361
362Args:
363 previous_request: The request for the previous page. (required)
364 previous_response: The response from the request for the previous page. (required)
365
366Returns:
367 A request object that you can call &#x27;execute()&#x27; on to request the next
368 page. Returns None if there are no more items in the collection.
369 </pre>
370</div>
371
372<div class="method">
373 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
374 <pre>Updates a property.
375
376Args:
377 name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
378 body: object, The request body.
379 The object takes the form of:
380
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700381{ # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700382 &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 -0800383 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &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 -0400385 &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 -0800386 &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 -0400387 &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 -0800388 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
389 &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 -0800390 &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 -0700391 &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 -0700392 &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 -0800393 &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 -0800394}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700395
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800396 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 -0700397 x__xgafv: string, V1 error format.
398 Allowed values
399 1 - v1 error format
400 2 - v2 error format
401
402Returns:
403 An object of the form:
404
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700405 { # A resource message representing a Google Analytics GA4 property.
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700406 &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 -0800407 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
408 &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 -0400409 &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 -0800410 &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 -0400411 &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 -0800412 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
413 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
414 &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 -0700415 &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 -0700416 &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 -0800417 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
418}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700419</div>
420
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700421<div class="method">
yoshi-code-bot96afc042021-08-24 00:22:31 -0700422 <code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
423 <pre>Updates the singleton data retention settings for this property.
424
425Args:
426 name: string, Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
427 body: object, The request body.
428 The object takes the form of:
429
430{ # Settings values for data retention. This is a singleton resource.
431 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
432 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
433 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
434}
435
436 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.
437 x__xgafv: string, V1 error format.
438 Allowed values
439 1 - v1 error format
440 2 - v2 error format
441
442Returns:
443 An object of the form:
444
445 { # Settings values for data retention. This is a singleton resource.
446 &quot;eventDataRetention&quot;: &quot;A String&quot;, # The length of time that event-level data is retained.
447 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
448 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
449}</pre>
450</div>
451
452<div class="method">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700453 <code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
454 <pre>Updates Google Signals settings for a property.
455
456Args:
457 name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot; (required)
458 body: object, The request body.
459 The object takes the form of:
460
461{ # Settings values for Google Signals. This is a singleton resource.
462 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
463 &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;
464 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
465}
466
467 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.
468 x__xgafv: string, V1 error format.
469 Allowed values
470 1 - v1 error format
471 2 - v2 error format
472
473Returns:
474 An object of the form:
475
476 { # Settings values for Google Signals. This is a singleton resource.
477 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
478 &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;
479 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
480}</pre>
481</div>
482
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700483</body></html>