blob: 73fedf18463b3546ec3e66e094151d5d3750492b [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070098 <code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
99</p>
100<p class="firstline">Returns the firebaseLinks Resource.</p>
101
102<p class="toc_element">
103 <code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
104</p>
105<p class="firstline">Returns the googleAdsLinks Resource.</p>
106
107<p class="toc_element">
108 <code><a href="analyticsadmin_v1alpha.properties.iosAppDataStreams.html">iosAppDataStreams()</a></code>
109</p>
110<p class="firstline">Returns the iosAppDataStreams Resource.</p>
111
112<p class="toc_element">
113 <code><a href="analyticsadmin_v1alpha.properties.userLinks.html">userLinks()</a></code>
114</p>
115<p class="firstline">Returns the userLinks Resource.</p>
116
117<p class="toc_element">
118 <code><a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams()</a></code>
119</p>
120<p class="firstline">Returns the webDataStreams Resource.</p>
121
122<p class="toc_element">
123 <code><a href="#close">close()</a></code></p>
124<p class="firstline">Close httplib2 connections.</p>
125<p class="toc_element">
126 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700127<p class="firstline">Creates an "GA4" property with the specified location and attributes.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700128<p class="toc_element">
129 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700130<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 -0700131<p class="toc_element">
132 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800133<p class="firstline">Lookup for a single "GA4" Property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134<p class="toc_element">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700135 <code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
136<p class="firstline">Lookup for Google Signals settings for a property.</p>
137<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 <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 -0700139<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 -0700140<p class="toc_element">
141 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
142<p class="firstline">Retrieves the next page of results.</p>
143<p class="toc_element">
144 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
145<p class="firstline">Updates a property.</p>
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700146<p class="toc_element">
147 <code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
148<p class="firstline">Updates Google Signals settings for a property.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149<h3>Method Details</h3>
150<div class="method">
151 <code class="details" id="close">close()</code>
152 <pre>Close httplib2 connections.</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700157 <pre>Creates an &quot;GA4&quot; property with the specified location and attributes.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700158
159Args:
160 body: object, The request body.
161 The object takes the form of:
162
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700163{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &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 -0400166 &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 -0800167 &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 -0400168 &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 -0800169 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
170 &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 -0800171 &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-bota8b35b92021-03-31 13:33:30 -0700172 &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 -0800173 &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 -0800174}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700175
176 x__xgafv: string, V1 error format.
177 Allowed values
178 1 - v1 error format
179 2 - v2 error format
180
181Returns:
182 An object of the form:
183
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700184 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
186 &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 -0400187 &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 -0800188 &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 -0400189 &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 -0800190 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
191 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
192 &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-bota8b35b92021-03-31 13:33:30 -0700193 &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 -0800194 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
195}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196</div>
197
198<div class="method">
199 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700200 <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 -0700201
202Args:
203 name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
204 x__xgafv: string, V1 error format.
205 Allowed values
206 1 - v1 error format
207 2 - v2 error format
208
209Returns:
210 An object of the form:
211
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400212 { # A resource message representing a Google Analytics GA4 property.
213 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
214 &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;
215 &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.
216 &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.
217 &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.
218 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
219 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
220 &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;
221 &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;
222 &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 -0800223}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700224</div>
225
226<div class="method">
227 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800228 <pre>Lookup for a single &quot;GA4&quot; Property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700229
230Args:
231 name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
232 x__xgafv: string, V1 error format.
233 Allowed values
234 1 - v1 error format
235 2 - v2 error format
236
237Returns:
238 An object of the form:
239
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700240 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800241 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
242 &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 -0400243 &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 -0800244 &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 -0400245 &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 -0800246 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
247 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
248 &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-bota8b35b92021-03-31 13:33:30 -0700249 &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 -0800250 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
251}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700252</div>
253
254<div class="method">
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700255 <code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
256 <pre>Lookup for Google Signals settings for a property.
257
258Args:
259 name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265Returns:
266 An object of the form:
267
268 { # Settings values for Google Signals. This is a singleton resource.
269 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
270 &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;
271 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
272}</pre>
273</div>
274
275<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800276 <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 -0700277 <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 -0700278
279Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800280 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 -0800281 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)
282 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 -0800283 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 -0700284 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 { # Response message for ListProperties RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800293 &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.
294 &quot;properties&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
295 { # A resource message representing a Google Analytics GA4 property.
296 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
297 &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 -0400298 &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 -0800299 &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 -0400300 &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 -0800301 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
302 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
303 &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-bota8b35b92021-03-31 13:33:30 -0700304 &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 -0800305 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
306 },
307 ],
308}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700309</div>
310
311<div class="method">
312 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
313 <pre>Retrieves the next page of results.
314
315Args:
316 previous_request: The request for the previous page. (required)
317 previous_response: The response from the request for the previous page. (required)
318
319Returns:
320 A request object that you can call &#x27;execute()&#x27; on to request the next
321 page. Returns None if there are no more items in the collection.
322 </pre>
323</div>
324
325<div class="method">
326 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
327 <pre>Updates a property.
328
329Args:
330 name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
331 body: object, The request body.
332 The object takes the form of:
333
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700334{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800335 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800336 &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 -0400337 &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 -0800338 &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 -0400339 &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 -0800340 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
341 &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 -0800342 &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-bota8b35b92021-03-31 13:33:30 -0700343 &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 -0800344 &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 -0800345}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700346
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800347 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 -0700348 x__xgafv: string, V1 error format.
349 Allowed values
350 1 - v1 error format
351 2 - v2 error format
352
353Returns:
354 An object of the form:
355
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700356 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800357 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
358 &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 -0400359 &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 -0800360 &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 -0400361 &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 -0800362 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
363 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
364 &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-bota8b35b92021-03-31 13:33:30 -0700365 &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 -0800366 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
367}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700368</div>
369
yoshi-code-bot7700bbf2021-05-20 04:44:03 -0700370<div class="method">
371 <code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
372 <pre>Updates Google Signals settings for a property.
373
374Args:
375 name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot; (required)
376 body: object, The request body.
377 The object takes the form of:
378
379{ # Settings values for Google Signals. This is a singleton resource.
380 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
381 &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;
382 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
383}
384
385 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.
386 x__xgafv: string, V1 error format.
387 Allowed values
388 1 - v1 error format
389 2 - v2 error format
390
391Returns:
392 An object of the form:
393
394 { # Settings values for Google Signals. This is a singleton resource.
395 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
396 &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;
397 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
398}</pre>
399</div>
400
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700401</body></html>