blob: 2aad7fe5f15e17c3d9f8c5cebda64ed12160f4b2 [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 Automation Botcc94ec82021-01-15 07:10:04 -0800135 <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 -0700136<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 -0700137<p class="toc_element">
138 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
139<p class="firstline">Retrieves the next page of results.</p>
140<p class="toc_element">
141 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
142<p class="firstline">Updates a property.</p>
143<h3>Method Details</h3>
144<div class="method">
145 <code class="details" id="close">close()</code>
146 <pre>Close httplib2 connections.</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700151 <pre>Creates an &quot;GA4&quot; property with the specified location and attributes.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152
153Args:
154 body: object, The request body.
155 The object takes the form of:
156
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700157{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800158 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800159 &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 -0400160 &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 -0800161 &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 -0400162 &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 -0800163 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
164 &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 -0800165 &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 -0700166 &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 -0800167 &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 -0800168}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700169
170 x__xgafv: string, V1 error format.
171 Allowed values
172 1 - v1 error format
173 2 - v2 error format
174
175Returns:
176 An object of the form:
177
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700178 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800179 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
180 &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 -0400181 &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 -0800182 &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 -0400183 &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 -0800184 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
185 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
186 &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 -0700187 &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 -0800188 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
189}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700190</div>
191
192<div class="method">
193 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700194 <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 -0700195
196Args:
197 name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 An object of the form:
205
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400206 { # A resource message representing a Google Analytics GA4 property.
207 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
208 &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;
209 &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.
210 &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.
211 &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.
212 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
213 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
214 &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;
215 &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;
216 &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 -0800217}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700218</div>
219
220<div class="method">
221 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800222 <pre>Lookup for a single &quot;GA4&quot; Property.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223
224Args:
225 name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231Returns:
232 An object of the form:
233
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700234 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800235 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
236 &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 -0400237 &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 -0800238 &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 -0400239 &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 -0800240 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
241 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
242 &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 -0700243 &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 -0800244 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
245}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700246</div>
247
248<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 <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 -0700250 <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 -0700251
252Args:
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800253 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 -0800254 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)
255 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 -0800256 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 -0700257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
265 { # Response message for ListProperties RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800266 &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.
267 &quot;properties&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
268 { # A resource message representing a Google Analytics GA4 property.
269 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
270 &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 -0400271 &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 -0800272 &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 -0400273 &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 -0800274 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
275 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
276 &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 -0700277 &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 -0800278 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
279 },
280 ],
281}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700282</div>
283
284<div class="method">
285 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
286 <pre>Retrieves the next page of results.
287
288Args:
289 previous_request: The request for the previous page. (required)
290 previous_response: The response from the request for the previous page. (required)
291
292Returns:
293 A request object that you can call &#x27;execute()&#x27; on to request the next
294 page. Returns None if there are no more items in the collection.
295 </pre>
296</div>
297
298<div class="method">
299 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
300 <pre>Updates a property.
301
302Args:
303 name: string, Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
304 body: object, The request body.
305 The object takes the form of:
306
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700307{ # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800308 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800309 &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 -0400310 &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 -0800311 &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 -0400312 &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 -0800313 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
314 &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 -0800315 &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 -0700316 &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 -0800317 &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 -0800318}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700319
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800320 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 -0700321 x__xgafv: string, V1 error format.
322 Allowed values
323 1 - v1 error format
324 2 - v2 error format
325
326Returns:
327 An object of the form:
328
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700329 { # A resource message representing a Google Analytics GA4 property.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800330 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
331 &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 -0400332 &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 -0800333 &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 -0400334 &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 -0800335 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
336 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
337 &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 -0700338 &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 -0800339 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
340}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700341</div>
342
343</body></html>