Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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.accessBindings.html">accessBindings()</a></code>
79 </p>
80 <p class="firstline">Returns the accessBindings Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="analyticsadmin_v1alpha.properties.adSenseLinks.html">adSenseLinks()</a></code>
84 </p>
85 <p class="firstline">Returns the adSenseLinks Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="analyticsadmin_v1alpha.properties.audiences.html">audiences()</a></code>
89 </p>
90 <p class="firstline">Returns the audiences Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="analyticsadmin_v1alpha.properties.bigQueryLinks.html">bigQueryLinks()</a></code>
94 </p>
95 <p class="firstline">Returns the bigQueryLinks Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="analyticsadmin_v1alpha.properties.calculatedMetrics.html">calculatedMetrics()</a></code>
99 </p>
100 <p class="firstline">Returns the calculatedMetrics Resource.</p>
101
102 <p class="toc_element">
103 <code><a href="analyticsadmin_v1alpha.properties.channelGroups.html">channelGroups()</a></code>
104 </p>
105 <p class="firstline">Returns the channelGroups Resource.</p>
106
107 <p class="toc_element">
108 <code><a href="analyticsadmin_v1alpha.properties.conversionEvents.html">conversionEvents()</a></code>
109 </p>
110 <p class="firstline">Returns the conversionEvents Resource.</p>
111
112 <p class="toc_element">
113 <code><a href="analyticsadmin_v1alpha.properties.customDimensions.html">customDimensions()</a></code>
114 </p>
115 <p class="firstline">Returns the customDimensions Resource.</p>
116
117 <p class="toc_element">
118 <code><a href="analyticsadmin_v1alpha.properties.customMetrics.html">customMetrics()</a></code>
119 </p>
120 <p class="firstline">Returns the customMetrics Resource.</p>
121
122 <p class="toc_element">
123 <code><a href="analyticsadmin_v1alpha.properties.dataStreams.html">dataStreams()</a></code>
124 </p>
125 <p class="firstline">Returns the dataStreams Resource.</p>
126
127 <p class="toc_element">
128 <code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinkProposals.html">displayVideo360AdvertiserLinkProposals()</a></code>
129 </p>
130 <p class="firstline">Returns the displayVideo360AdvertiserLinkProposals Resource.</p>
131
132 <p class="toc_element">
133 <code><a href="analyticsadmin_v1alpha.properties.displayVideo360AdvertiserLinks.html">displayVideo360AdvertiserLinks()</a></code>
134 </p>
135 <p class="firstline">Returns the displayVideo360AdvertiserLinks Resource.</p>
136
137 <p class="toc_element">
138 <code><a href="analyticsadmin_v1alpha.properties.expandedDataSets.html">expandedDataSets()</a></code>
139 </p>
140 <p class="firstline">Returns the expandedDataSets Resource.</p>
141
142 <p class="toc_element">
143 <code><a href="analyticsadmin_v1alpha.properties.firebaseLinks.html">firebaseLinks()</a></code>
144 </p>
145 <p class="firstline">Returns the firebaseLinks Resource.</p>
146
147 <p class="toc_element">
148 <code><a href="analyticsadmin_v1alpha.properties.googleAdsLinks.html">googleAdsLinks()</a></code>
149 </p>
150 <p class="firstline">Returns the googleAdsLinks Resource.</p>
151
152 <p class="toc_element">
153 <code><a href="analyticsadmin_v1alpha.properties.keyEvents.html">keyEvents()</a></code>
154 </p>
155 <p class="firstline">Returns the keyEvents Resource.</p>
156
157 <p class="toc_element">
158 <code><a href="analyticsadmin_v1alpha.properties.reportingDataAnnotations.html">reportingDataAnnotations()</a></code>
159 </p>
160 <p class="firstline">Returns the reportingDataAnnotations Resource.</p>
161
162 <p class="toc_element">
163 <code><a href="analyticsadmin_v1alpha.properties.rollupPropertySourceLinks.html">rollupPropertySourceLinks()</a></code>
164 </p>
165 <p class="firstline">Returns the rollupPropertySourceLinks Resource.</p>
166
167 <p class="toc_element">
168 <code><a href="analyticsadmin_v1alpha.properties.searchAds360Links.html">searchAds360Links()</a></code>
169 </p>
170 <p class="firstline">Returns the searchAds360Links Resource.</p>
171
172 <p class="toc_element">
173 <code><a href="analyticsadmin_v1alpha.properties.subpropertyEventFilters.html">subpropertyEventFilters()</a></code>
174 </p>
175 <p class="firstline">Returns the subpropertyEventFilters Resource.</p>
176
177 <p class="toc_element">
178 <code><a href="analyticsadmin_v1alpha.properties.subpropertySyncConfigs.html">subpropertySyncConfigs()</a></code>
179 </p>
180 <p class="firstline">Returns the subpropertySyncConfigs Resource.</p>
181
182 <p class="toc_element">
183 <code><a href="#acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</a></code></p>
184 <p class="firstline">Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.</p>
185 <p class="toc_element">
186 <code><a href="#close">close()</a></code></p>
187 <p class="firstline">Close httplib2 connections.</p>
188 <p class="toc_element">
189 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
190 <p class="firstline">Creates a Google Analytics property with the specified location and attributes.</p>
191 <p class="toc_element">
192 <code><a href="#createRollupProperty">createRollupProperty(body=None, x__xgafv=None)</a></code></p>
193 <p class="firstline">Create a roll-up property and all roll-up property source links.</p>
194 <p class="toc_element">
195 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
196 <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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.</p>
197 <p class="toc_element">
198 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
199 <p class="firstline">Lookup for a single GA Property.</p>
200 <p class="toc_element">
201 <code><a href="#getAttributionSettings">getAttributionSettings(name, x__xgafv=None)</a></code></p>
202 <p class="firstline">Lookup for a AttributionSettings singleton.</p>
203 <p class="toc_element">
204 <code><a href="#getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</a></code></p>
205 <p class="firstline">Returns the singleton data retention settings for this property.</p>
206 <p class="toc_element">
207 <code><a href="#getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</a></code></p>
208 <p class="firstline">Lookup for Google Signals settings for a property.</p>
209 <p class="toc_element">
210 <code><a href="#getReportingIdentitySettings">getReportingIdentitySettings(name, x__xgafv=None)</a></code></p>
211 <p class="firstline">Returns the reporting identity settings for this property.</p>
212 <p class="toc_element">
213 <code><a href="#getUserProvidedDataSettings">getUserProvidedDataSettings(name, x__xgafv=None)</a></code></p>
214 <p class="firstline">Looks up settings related to user-provided data for a property.</p>
215 <p class="toc_element">
216 <code><a href="#list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
217 <p class="firstline">Returns child Properties under the specified parent Account. 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>
218 <p class="toc_element">
219 <code><a href="#list_next">list_next()</a></code></p>
220 <p class="firstline">Retrieves the next page of results.</p>
221 <p class="toc_element">
222 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
223 <p class="firstline">Updates a property.</p>
224 <p class="toc_element">
225 <code><a href="#provisionSubproperty">provisionSubproperty(body=None, x__xgafv=None)</a></code></p>
226 <p class="firstline">Create a subproperty and a subproperty event filter that applies to the created subproperty.</p>
227 <p class="toc_element">
228 <code><a href="#runAccessReport">runAccessReport(entity, body=None, x__xgafv=None)</a></code></p>
229 <p class="firstline">Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.</p>
230 <p class="toc_element">
231 <code><a href="#submitUserDeletion">submitUserDeletion(name, body=None, x__xgafv=None)</a></code></p>
232 <p class="firstline">Submits a request for user deletion for a property.</p>
233 <p class="toc_element">
234 <code><a href="#updateAttributionSettings">updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
235 <p class="firstline">Updates attribution settings on a property.</p>
236 <p class="toc_element">
237 <code><a href="#updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
238 <p class="firstline">Updates the singleton data retention settings for this property.</p>
239 <p class="toc_element">
240 <code><a href="#updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
241 <p class="firstline">Updates Google Signals settings for a property.</p>
242 <p class="toc_element">
243 <code><a href="#updateReportingIdentitySettings">updateReportingIdentitySettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
244 <p class="firstline">Updates the reporting identity settings for this property.</p>
245 <h3>Method Details</h3>
246 <div class="method">
247 <code class="details" id="acknowledgeUserDataCollection">acknowledgeUserDataCollection(property, body=None, x__xgafv=None)</code>
248 <pre>Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.
249
250 Args:
251 property: string, Required. The property for which to acknowledge user data collection. (required)
252 body: object, The request body.
253 The object takes the form of:
254
255 { # Request message for AcknowledgeUserDataCollection RPC.
256 &quot;acknowledgement&quot;: &quot;A String&quot;, # Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: &quot;I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property.&quot;
257 }
258
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264 Returns:
265 An object of the form:
266
267 { # Response message for AcknowledgeUserDataCollection RPC.
268 }</pre>
269 </div>
270
271 <div class="method">
272 <code class="details" id="close">close()</code>
273 <pre>Close httplib2 connections.</pre>
274 </div>
275
276 <div class="method">
277 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
278 <pre>Creates a Google Analytics property with the specified location and attributes.
279
280 Args:
281 body: object, The request body.
282 The object takes the form of:
283
284 { # A resource message representing a Google Analytics property.
285 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
286 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
287 &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;
288 &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.
289 &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.
290 &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.
291 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
292 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
293 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
294 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
295 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
296 &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;
297 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
298 }
299
300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
304
305 Returns:
306 An object of the form:
307
308 { # A resource message representing a Google Analytics property.
309 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
310 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
311 &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;
312 &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.
313 &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.
314 &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.
315 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
316 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
317 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
318 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
319 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
320 &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;
321 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
322 }</pre>
323 </div>
324
325 <div class="method">
326 <code class="details" id="createRollupProperty">createRollupProperty(body=None, x__xgafv=None)</code>
327 <pre>Create a roll-up property and all roll-up property source links.
328
329 Args:
330 body: object, The request body.
331 The object takes the form of:
332
333 { # Request message for CreateRollupProperty RPC.
334 &quot;rollupProperty&quot;: { # A resource message representing a Google Analytics property. # Required. The roll-up property to create.
335 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
336 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
337 &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;
338 &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.
339 &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.
340 &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.
341 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
342 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
343 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
344 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
345 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
346 &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;
347 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
348 },
349 &quot;sourceProperties&quot;: [ # Optional. The resource names of properties that will be sources to the created roll-up property.
350 &quot;A String&quot;,
351 ],
352 }
353
354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
358
359 Returns:
360 An object of the form:
361
362 { # Response message for CreateRollupProperty RPC.
363 &quot;rollupProperty&quot;: { # A resource message representing a Google Analytics property. # The created roll-up property.
364 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
365 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
366 &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;
367 &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.
368 &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.
369 &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.
370 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
371 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
372 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
373 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
374 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
375 &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;
376 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
377 },
378 &quot;rollupPropertySourceLinks&quot;: [ # The created roll-up property source links.
379 { # A link that references a source property under the parent rollup property.
380 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this RollupPropertySourceLink. Format: &#x27;properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link}&#x27; Format: &#x27;properties/123/rollupPropertySourceLinks/456&#x27;
381 &quot;sourceProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the source property. Format: properties/{property_id} Example: &quot;properties/789&quot;
382 },
383 ],
384 }</pre>
385 </div>
386
387 <div class="method">
388 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
389 <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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
390
391 Args:
392 name: string, Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
397
398 Returns:
399 An object of the form:
400
401 { # A resource message representing a Google Analytics property.
402 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
403 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
404 &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;
405 &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.
406 &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.
407 &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.
408 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
409 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
410 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
411 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
412 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
413 &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;
414 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
415 }</pre>
416 </div>
417
418 <div class="method">
419 <code class="details" id="get">get(name, x__xgafv=None)</code>
420 <pre>Lookup for a single GA Property.
421
422 Args:
423 name: string, Required. The name of the property to lookup. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
424 x__xgafv: string, V1 error format.
425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
428
429 Returns:
430 An object of the form:
431
432 { # A resource message representing a Google Analytics property.
433 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
434 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
435 &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;
436 &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.
437 &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.
438 &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.
439 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
440 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
441 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
442 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
443 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
444 &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;
445 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
446 }</pre>
447 </div>
448
449 <div class="method">
450 <code class="details" id="getAttributionSettings">getAttributionSettings(name, x__xgafv=None)</code>
451 <pre>Lookup for a AttributionSettings singleton.
452
453 Args:
454 name: string, Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings (required)
455 x__xgafv: string, V1 error format.
456 Allowed values
457 1 - v1 error format
458 2 - v2 error format
459
460 Returns:
461 An object of the form:
462
463 { # The attribution settings used for a given property. This is a singleton resource.
464 &quot;acquisitionConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
465 &quot;adsWebConversionDataExportScope&quot;: &quot;A String&quot;, # Required. The Conversion Export Scope for data exported to linked Ads Accounts.
466 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: &quot;properties/1000/attributionSettings&quot;
467 &quot;otherConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
468 &quot;reportingAttributionModel&quot;: &quot;A String&quot;, # Required. The reporting attribution model used to calculate conversion credit in this property&#x27;s reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
469 }</pre>
470 </div>
471
472 <div class="method">
473 <code class="details" id="getDataRetentionSettings">getDataRetentionSettings(name, x__xgafv=None)</code>
474 <pre>Returns the singleton data retention settings for this property.
475
476 Args:
477 name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: &quot;properties/1000/dataRetentionSettings&quot; (required)
478 x__xgafv: string, V1 error format.
479 Allowed values
480 1 - v1 error format
481 2 - v2 error format
482
483 Returns:
484 An object of the form:
485
486 { # Settings values for data retention. This is a singleton resource.
487 &quot;eventDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that event-level data is retained.
488 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
489 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
490 &quot;userDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that user-level data is retained.
491 }</pre>
492 </div>
493
494 <div class="method">
495 <code class="details" id="getGoogleSignalsSettings">getGoogleSignalsSettings(name, x__xgafv=None)</code>
496 <pre>Lookup for Google Signals settings for a property.
497
498 Args:
499 name: string, Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings (required)
500 x__xgafv: string, V1 error format.
501 Allowed values
502 1 - v1 error format
503 2 - v2 error format
504
505 Returns:
506 An object of the form:
507
508 { # Settings values for Google Signals. This is a singleton resource.
509 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
510 &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;
511 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
512 }</pre>
513 </div>
514
515 <div class="method">
516 <code class="details" id="getReportingIdentitySettings">getReportingIdentitySettings(name, x__xgafv=None)</code>
517 <pre>Returns the reporting identity settings for this property.
518
519 Args:
520 name: string, Required. The name of the settings to lookup. Format: properties/{property}/reportingIdentitySettings Example: &quot;properties/1000/reportingIdentitySettings&quot; (required)
521 x__xgafv: string, V1 error format.
522 Allowed values
523 1 - v1 error format
524 2 - v2 error format
525
526 Returns:
527 An object of the form:
528
529 { # A resource containing settings related to reporting identity.
530 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: &quot;properties/1234/reportingIdentitySettings&quot;
531 &quot;reportingIdentity&quot;: &quot;A String&quot;, # The strategy used for identifying user identities in reports.
532 }</pre>
533 </div>
534
535 <div class="method">
536 <code class="details" id="getUserProvidedDataSettings">getUserProvidedDataSettings(name, x__xgafv=None)</code>
537 <pre>Looks up settings related to user-provided data for a property.
538
539 Args:
540 name: string, Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings (required)
541 x__xgafv: string, V1 error format.
542 Allowed values
543 1 - v1 error format
544 2 - v2 error format
545
546 Returns:
547 An object of the form:
548
549 { # Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property.
550 &quot;automaticallyDetectedDataCollectionEnabled&quot;: True or False, # Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true.
551 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: &quot;properties/1000/userProvidedDataSettings&quot;
552 &quot;userProvidedDataCollectionEnabled&quot;: True or False, # Optional. Whether this property accepts user-provided data sent to it.
553 }</pre>
554 </div>
555
556 <div class="method">
557 <code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
558 <pre>Returns child Properties under the specified parent Account. 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.
559
560 Args:
561 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/property) or `ancestor:`(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. | | parent:properties/123 | The property with property id: 123. | | ancestor: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. | ```
562 pageSize: integer, Optional. 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)
563 pageToken: string, Optional. 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.
564 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.
565 x__xgafv: string, V1 error format.
566 Allowed values
567 1 - v1 error format
568 2 - v2 error format
569
570 Returns:
571 An object of the form:
572
573 { # Response message for ListProperties RPC.
574 &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.
575 &quot;properties&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
576 { # A resource message representing a Google Analytics property.
577 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
578 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
579 &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;
580 &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.
581 &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.
582 &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.
583 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
584 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
585 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
586 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
587 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
588 &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;
589 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
590 },
591 ],
592 }</pre>
593 </div>
594
595 <div class="method">
596 <code class="details" id="list_next">list_next()</code>
597 <pre>Retrieves the next page of results.
598
599 Args:
600 previous_request: The request for the previous page. (required)
601 previous_response: The response from the request for the previous page. (required)
602
603 Returns:
604 A request object that you can call &#x27;execute()&#x27; on to request the next
605 page. Returns None if there are no more items in the collection.
606 </pre>
607 </div>
608
609 <div class="method">
610 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
611 <pre>Updates a property.
612
613 Args:
614 name: string, Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot; (required)
615 body: object, The request body.
616 The object takes the form of:
617
618 { # A resource message representing a Google Analytics property.
619 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
620 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
621 &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;
622 &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.
623 &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.
624 &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.
625 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
626 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
627 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
628 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
629 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
630 &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;
631 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
632 }
633
634 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.
635 x__xgafv: string, V1 error format.
636 Allowed values
637 1 - v1 error format
638 2 - v2 error format
639
640 Returns:
641 An object of the form:
642
643 { # A resource message representing a Google Analytics property.
644 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
645 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
646 &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;
647 &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.
648 &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.
649 &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.
650 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
651 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
652 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
653 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
654 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
655 &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;
656 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
657 }</pre>
658 </div>
659
660 <div class="method">
661 <code class="details" id="provisionSubproperty">provisionSubproperty(body=None, x__xgafv=None)</code>
662 <pre>Create a subproperty and a subproperty event filter that applies to the created subproperty.
663
664 Args:
665 body: object, The request body.
666 The object takes the form of:
667
668 { # Request message for CreateSubproperty RPC.
669 &quot;customDimensionAndMetricSynchronizationMode&quot;: &quot;A String&quot;, # Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics
670 &quot;subproperty&quot;: { # A resource message representing a Google Analytics property. # Required. The subproperty to create.
671 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
672 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
673 &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;
674 &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.
675 &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.
676 &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.
677 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
678 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
679 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
680 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
681 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
682 &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;
683 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
684 },
685 &quot;subpropertyEventFilter&quot;: { # A resource message representing a Google Analytics subproperty event filter. # Optional. The subproperty event filter to create on an ordinary property.
686 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
687 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
688 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
689 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
690 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
691 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
692 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
693 &quot;nullFilter&quot;: True or False, # A filter for null values.
694 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
695 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
696 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
697 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
698 },
699 },
700 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
701 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
702 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
703 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
704 ],
705 },
706 },
707 },
708 ],
709 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
710 },
711 }
712
713 x__xgafv: string, V1 error format.
714 Allowed values
715 1 - v1 error format
716 2 - v2 error format
717
718 Returns:
719 An object of the form:
720
721 { # Response message for ProvisionSubproperty RPC.
722 &quot;subproperty&quot;: { # A resource message representing a Google Analytics property. # The created subproperty.
723 &quot;account&quot;: &quot;A String&quot;, # Immutable. The resource name of the parent account Format: accounts/{account_id} Example: &quot;accounts/123&quot;
724 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when the entity was originally created.
725 &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;
726 &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.
727 &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.
728 &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.
729 &quot;industryCategory&quot;: &quot;A String&quot;, # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK
730 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this property. Format: properties/{property_id} Example: &quot;properties/1000&quot;
731 &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}, properties/{property} Example: &quot;accounts/100&quot;, &quot;properties/101&quot;
732 &quot;propertyType&quot;: &quot;A String&quot;, # Immutable. The property type for this Property resource. When creating a property, if the type is &quot;PROPERTY_TYPE_UNSPECIFIED&quot;, then &quot;ORDINARY_PROPERTY&quot; will be implied.
733 &quot;serviceLevel&quot;: &quot;A String&quot;, # Output only. The Google Analytics service level that applies to this property.
734 &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;
735 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when entity payload fields were last updated.
736 },
737 &quot;subpropertyEventFilter&quot;: { # A resource message representing a Google Analytics subproperty event filter. # The created subproperty event filter.
738 &quot;applyToProperty&quot;: &quot;A String&quot;, # Immutable. Resource name of the Subproperty that uses this filter.
739 &quot;filterClauses&quot;: [ # Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND&#x27;ed together to determine what data is sent to the subproperty.
740 { # A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty&#x27;s data) or exclusive (events satisfying the filter clause are excluded from the subproperty&#x27;s data).
741 &quot;filterClauseType&quot;: &quot;A String&quot;, # Required. The type for the filter clause.
742 &quot;filterExpression&quot;: { # A logical expression of Subproperty event filters. # Required. The logical expression for what events are sent to the subproperty.
743 &quot;filterCondition&quot;: { # A specific filter expression # Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression.
744 &quot;fieldName&quot;: &quot;A String&quot;, # Required. The field that is being filtered.
745 &quot;nullFilter&quot;: True or False, # A filter for null values.
746 &quot;stringFilter&quot;: { # A filter for a string-type dimension that matches a particular pattern. # A filter for a string-type dimension that matches a particular pattern.
747 &quot;caseSensitive&quot;: True or False, # Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.
748 &quot;matchType&quot;: &quot;A String&quot;, # Required. The match type for the string filter.
749 &quot;value&quot;: &quot;A String&quot;, # Required. The string value used for the matching.
750 },
751 },
752 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression # A filter expression to be NOT&#x27;ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression.
753 &quot;orGroup&quot;: { # A list of Subproperty event filter expressions. # A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions.
754 &quot;filterExpressions&quot;: [ # Required. Unordered list. A list of Subproperty event filter expressions
755 # Object with schema name: GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression
756 ],
757 },
758 },
759 },
760 ],
761 &quot;name&quot;: &quot;A String&quot;, # Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678
762 },
763 }</pre>
764 </div>
765
766 <div class="method">
767 <code class="details" id="runAccessReport">runAccessReport(entity, body=None, x__xgafv=None)</code>
768 <pre>Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren&#x27;t related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase &amp; Admob that can retrieve data from Google Analytics through a linkage. These records don&#x27;t include property configuration changes like adding a stream or changing a property&#x27;s time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
769
770 Args:
771 entity: string, The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example &#x27;properties/123&#x27; if &quot;123&quot; is your Google Analytics property ID. To request at the account level, entity should be for example &#x27;accounts/1234&#x27; if &quot;1234&quot; is your Google Analytics Account ID. (required)
772 body: object, The request body.
773 The object takes the form of:
774
775 { # The request for a Data Access Record Report.
776 &quot;dateRanges&quot;: [ # Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges.
777 { # A contiguous range of days: startDate, startDate + 1, ..., endDate.
778 &quot;endDate&quot;: &quot;A String&quot;, # The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request&#x27;s time zone.
779 &quot;startDate&quot;: &quot;A String&quot;, # The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request&#x27;s time zone.
780 },
781 ],
782 &quot;dimensionFilter&quot;: { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.
783 &quot;accessFilter&quot;: { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter&#x27;s field names need to be either all dimensions or all metrics.
784 &quot;betweenFilter&quot;: { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
785 &quot;fromValue&quot;: { # To represent a number. # Begins with this number.
786 &quot;doubleValue&quot;: 3.14, # Double value
787 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
788 },
789 &quot;toValue&quot;: { # To represent a number. # Ends with this number.
790 &quot;doubleValue&quot;: 3.14, # Double value
791 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
792 },
793 },
794 &quot;fieldName&quot;: &quot;A String&quot;, # The dimension name or metric name.
795 &quot;inListFilter&quot;: { # The result needs to be in a list of string values. # A filter for in list values.
796 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
797 &quot;values&quot;: [ # The list of string values. Must be non-empty.
798 &quot;A String&quot;,
799 ],
800 },
801 &quot;numericFilter&quot;: { # Filters for numeric or date values. # A filter for numeric or date values.
802 &quot;operation&quot;: &quot;A String&quot;, # The operation type for this filter.
803 &quot;value&quot;: { # To represent a number. # A numeric value or a date value.
804 &quot;doubleValue&quot;: 3.14, # Double value
805 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
806 },
807 },
808 &quot;stringFilter&quot;: { # The filter for strings. # Strings related filter.
809 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
810 &quot;matchType&quot;: &quot;A String&quot;, # The match type for this filter.
811 &quot;value&quot;: &quot;A String&quot;, # The string value used for the matching.
812 },
813 },
814 &quot;andGroup&quot;: { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
815 &quot;expressions&quot;: [ # A list of filter expressions.
816 # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
817 ],
818 },
819 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression # The FilterExpression is NOT of not_expression.
820 &quot;orGroup&quot;: { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
821 &quot;expressions&quot;: [ # A list of filter expressions.
822 # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
823 ],
824 },
825 },
826 &quot;dimensions&quot;: [ # The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.
827 { # Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings.
828 &quot;dimensionName&quot;: &quot;A String&quot;, # The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
829 },
830 ],
831 &quot;expandGroups&quot;: True or False, # Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.
832 &quot;includeAllUsers&quot;: True or False, # Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.
833 &quot;limit&quot;: &quot;A String&quot;, # The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren&#x27;t as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can&#x27;t get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
834 &quot;metricFilter&quot;: { # Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. # Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report&#x27;s rows, similar to SQL having-clause. Dimensions cannot be used in this filter.
835 &quot;accessFilter&quot;: { # An expression to filter dimension or metric values. # A primitive filter. In the same FilterExpression, all of the filter&#x27;s field names need to be either all dimensions or all metrics.
836 &quot;betweenFilter&quot;: { # To express that the result needs to be between two numbers (inclusive). # A filter for two values.
837 &quot;fromValue&quot;: { # To represent a number. # Begins with this number.
838 &quot;doubleValue&quot;: 3.14, # Double value
839 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
840 },
841 &quot;toValue&quot;: { # To represent a number. # Ends with this number.
842 &quot;doubleValue&quot;: 3.14, # Double value
843 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
844 },
845 },
846 &quot;fieldName&quot;: &quot;A String&quot;, # The dimension name or metric name.
847 &quot;inListFilter&quot;: { # The result needs to be in a list of string values. # A filter for in list values.
848 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
849 &quot;values&quot;: [ # The list of string values. Must be non-empty.
850 &quot;A String&quot;,
851 ],
852 },
853 &quot;numericFilter&quot;: { # Filters for numeric or date values. # A filter for numeric or date values.
854 &quot;operation&quot;: &quot;A String&quot;, # The operation type for this filter.
855 &quot;value&quot;: { # To represent a number. # A numeric value or a date value.
856 &quot;doubleValue&quot;: 3.14, # Double value
857 &quot;int64Value&quot;: &quot;A String&quot;, # Integer value
858 },
859 },
860 &quot;stringFilter&quot;: { # The filter for strings. # Strings related filter.
861 &quot;caseSensitive&quot;: True or False, # If true, the string value is case sensitive.
862 &quot;matchType&quot;: &quot;A String&quot;, # The match type for this filter.
863 &quot;value&quot;: &quot;A String&quot;, # The string value used for the matching.
864 },
865 },
866 &quot;andGroup&quot;: { # A list of filter expressions. # Each of the FilterExpressions in the and_group has an AND relationship.
867 &quot;expressions&quot;: [ # A list of filter expressions.
868 # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
869 ],
870 },
871 &quot;notExpression&quot;: # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression # The FilterExpression is NOT of not_expression.
872 &quot;orGroup&quot;: { # A list of filter expressions. # Each of the FilterExpressions in the or_group has an OR relationship.
873 &quot;expressions&quot;: [ # A list of filter expressions.
874 # Object with schema name: GoogleAnalyticsAdminV1alphaAccessFilterExpression
875 ],
876 },
877 },
878 &quot;metrics&quot;: [ # The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.
879 { # The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records.
880 &quot;metricName&quot;: &quot;A String&quot;, # The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` &amp; `orderBys`.
881 },
882 ],
883 &quot;offset&quot;: &quot;A String&quot;, # The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
884 &quot;orderBys&quot;: [ # Specifies how rows are ordered in the response.
885 { # Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.
886 &quot;desc&quot;: True or False, # If true, sorts by descending order. If false or unspecified, sorts in ascending order.
887 &quot;dimension&quot;: { # Sorts by dimension values. # Sorts results by a dimension&#x27;s values.
888 &quot;dimensionName&quot;: &quot;A String&quot;, # A dimension name in the request to order by.
889 &quot;orderType&quot;: &quot;A String&quot;, # Controls the rule for dimension value ordering.
890 },
891 &quot;metric&quot;: { # Sorts by metric values. # Sorts results by a metric&#x27;s values.
892 &quot;metricName&quot;: &quot;A String&quot;, # A metric name in the request to order by.
893 },
894 },
895 ],
896 &quot;returnEntityQuota&quot;: True or False, # Toggles whether to return the current state of this Analytics Property&#x27;s quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false.
897 &quot;timeZone&quot;: &quot;A String&quot;, # This request&#x27;s time zone if specified. If unspecified, the property&#x27;s time zone is used. The request&#x27;s time zone is used to interpret the start &amp; end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example &quot;America/New_York&quot; or &quot;Asia/Tokyo&quot;.
898 }
899
900 x__xgafv: string, V1 error format.
901 Allowed values
902 1 - v1 error format
903 2 - v2 error format
904
905 Returns:
906 An object of the form:
907
908 { # The customized Data Access Record Report response.
909 &quot;dimensionHeaders&quot;: [ # The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.
910 { # Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
911 &quot;dimensionName&quot;: &quot;A String&quot;, # The dimension&#x27;s name; for example &#x27;userEmail&#x27;.
912 },
913 ],
914 &quot;metricHeaders&quot;: [ # The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.
915 { # Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
916 &quot;metricName&quot;: &quot;A String&quot;, # The metric&#x27;s name; for example &#x27;accessCount&#x27;.
917 },
918 ],
919 &quot;quota&quot;: { # Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. # The quota state for this Analytics property including this request. This field doesn&#x27;t work with account-level requests.
920 &quot;concurrentRequests&quot;: { # Current state for a particular quota group. # Properties can use up to 50 concurrent requests.
921 &quot;consumed&quot;: 42, # Quota consumed by this request.
922 &quot;remaining&quot;: 42, # Quota remaining after this request.
923 },
924 &quot;serverErrorsPerProjectPerHour&quot;: { # Current state for a particular quota group. # Properties and cloud project pairs can have up to 50 server errors per hour.
925 &quot;consumed&quot;: 42, # Quota consumed by this request.
926 &quot;remaining&quot;: 42, # Quota remaining after this request.
927 },
928 &quot;tokensPerDay&quot;: { # Current state for a particular quota group. # Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.
929 &quot;consumed&quot;: 42, # Quota consumed by this request.
930 &quot;remaining&quot;: 42, # Quota remaining after this request.
931 },
932 &quot;tokensPerHour&quot;: { # Current state for a particular quota group. # Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.
933 &quot;consumed&quot;: 42, # Quota consumed by this request.
934 &quot;remaining&quot;: 42, # Quota remaining after this request.
935 },
936 &quot;tokensPerProjectPerHour&quot;: { # Current state for a particular quota group. # Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas.
937 &quot;consumed&quot;: 42, # Quota consumed by this request.
938 &quot;remaining&quot;: 42, # Quota remaining after this request.
939 },
940 },
941 &quot;rowCount&quot;: 42, # The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
942 &quot;rows&quot;: [ # Rows of dimension value combinations and metric values in the report.
943 { # Access report data for each row.
944 &quot;dimensionValues&quot;: [ # List of dimension values. These values are in the same order as specified in the request.
945 { # The value of a dimension.
946 &quot;value&quot;: &quot;A String&quot;, # The dimension value. For example, this value may be &#x27;France&#x27; for the &#x27;country&#x27; dimension.
947 },
948 ],
949 &quot;metricValues&quot;: [ # List of metric values. These values are in the same order as specified in the request.
950 { # The value of a metric.
951 &quot;value&quot;: &quot;A String&quot;, # The measurement value. For example, this value may be &#x27;13&#x27;.
952 },
953 ],
954 },
955 ],
956 }</pre>
957 </div>
958
959 <div class="method">
960 <code class="details" id="submitUserDeletion">submitUserDeletion(name, body=None, x__xgafv=None)</code>
961 <pre>Submits a request for user deletion for a property.
962
963 Args:
964 name: string, Required. The name of the property to submit user deletion for. (required)
965 body: object, The request body.
966 The object takes the form of:
967
968 { # Request message for SubmitUserDeletion RPC.
969 &quot;appInstanceId&quot;: &quot;A String&quot;, # Firebase [application instance ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId).
970 &quot;clientId&quot;: &quot;A String&quot;, # Google Analytics [client ID](https://support.google.com/analytics/answer/11593727).
971 &quot;userId&quot;: &quot;A String&quot;, # Google Analytics [user ID](https://firebase.google.com/docs/analytics/userid).
972 &quot;userProvidedData&quot;: &quot;A String&quot;, # [User-provided data](https://support.google.com/analytics/answer/14077171). May contain either one email address or one phone number. Email addresses should be normalized as such: * lowercase * remove periods before @ for gmail.com/googlemail.com addresses * remove all spaces Phone numbers should be normalized as such: * remove all non digit characters * add + prefix
973 }
974
975 x__xgafv: string, V1 error format.
976 Allowed values
977 1 - v1 error format
978 2 - v2 error format
979
980 Returns:
981 An object of the form:
982
983 { # Response message for SubmitUserDeletion RPC.
984 &quot;deletionRequestTime&quot;: &quot;A String&quot;, # Marks the moment for which all visitor data before this point should be deleted. This is set to the time at which the deletion request was received.
985 }</pre>
986 </div>
987
988 <div class="method">
989 <code class="details" id="updateAttributionSettings">updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
990 <pre>Updates attribution settings on a property.
991
992 Args:
993 name: string, Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: &quot;properties/1000/attributionSettings&quot; (required)
994 body: object, The request body.
995 The object takes the form of:
996
997 { # The attribution settings used for a given property. This is a singleton resource.
998 &quot;acquisitionConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
999 &quot;adsWebConversionDataExportScope&quot;: &quot;A String&quot;, # Required. The Conversion Export Scope for data exported to linked Ads Accounts.
1000 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: &quot;properties/1000/attributionSettings&quot;
1001 &quot;otherConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
1002 &quot;reportingAttributionModel&quot;: &quot;A String&quot;, # Required. The reporting attribution model used to calculate conversion credit in this property&#x27;s reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
1003 }
1004
1005 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.
1006 x__xgafv: string, V1 error format.
1007 Allowed values
1008 1 - v1 error format
1009 2 - v2 error format
1010
1011 Returns:
1012 An object of the form:
1013
1014 { # The attribution settings used for a given property. This is a singleton resource.
1015 &quot;acquisitionConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days.
1016 &quot;adsWebConversionDataExportScope&quot;: &quot;A String&quot;, # Required. The Conversion Export Scope for data exported to linked Ads Accounts.
1017 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: &quot;properties/1000/attributionSettings&quot;
1018 &quot;otherConversionEventLookbackWindow&quot;: &quot;A String&quot;, # Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days.
1019 &quot;reportingAttributionModel&quot;: &quot;A String&quot;, # Required. The reporting attribution model used to calculate conversion credit in this property&#x27;s reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected.
1020 }</pre>
1021 </div>
1022
1023 <div class="method">
1024 <code class="details" id="updateDataRetentionSettings">updateDataRetentionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
1025 <pre>Updates the singleton data retention settings for this property.
1026
1027 Args:
1028 name: string, Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings (required)
1029 body: object, The request body.
1030 The object takes the form of:
1031
1032 { # Settings values for data retention. This is a singleton resource.
1033 &quot;eventDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that event-level data is retained.
1034 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
1035 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
1036 &quot;userDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that user-level data is retained.
1037 }
1038
1039 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.
1040 x__xgafv: string, V1 error format.
1041 Allowed values
1042 1 - v1 error format
1043 2 - v2 error format
1044
1045 Returns:
1046 An object of the form:
1047
1048 { # Settings values for data retention. This is a singleton resource.
1049 &quot;eventDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that event-level data is retained.
1050 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings
1051 &quot;resetUserDataOnNewActivity&quot;: True or False, # If true, reset the retention period for the user identifier with every event from that user.
1052 &quot;userDataRetention&quot;: &quot;A String&quot;, # Required. The length of time that user-level data is retained.
1053 }</pre>
1054 </div>
1055
1056 <div class="method">
1057 <code class="details" id="updateGoogleSignalsSettings">updateGoogleSignalsSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
1058 <pre>Updates Google Signals settings for a property.
1059
1060 Args:
1061 name: string, Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: &quot;properties/1000/googleSignalsSettings&quot; (required)
1062 body: object, The request body.
1063 The object takes the form of:
1064
1065 { # Settings values for Google Signals. This is a singleton resource.
1066 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
1067 &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;
1068 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
1069 }
1070
1071 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.
1072 x__xgafv: string, V1 error format.
1073 Allowed values
1074 1 - v1 error format
1075 2 - v2 error format
1076
1077 Returns:
1078 An object of the form:
1079
1080 { # Settings values for Google Signals. This is a singleton resource.
1081 &quot;consent&quot;: &quot;A String&quot;, # Output only. Terms of Service acceptance.
1082 &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;
1083 &quot;state&quot;: &quot;A String&quot;, # Status of this setting.
1084 }</pre>
1085 </div>
1086
1087 <div class="method">
1088 <code class="details" id="updateReportingIdentitySettings">updateReportingIdentitySettings(name, body=None, updateMask=None, x__xgafv=None)</code>
1089 <pre>Updates the reporting identity settings for this property.
1090
1091 Args:
1092 name: string, Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: &quot;properties/1234/reportingIdentitySettings&quot; (required)
1093 body: object, The request body.
1094 The object takes the form of:
1095
1096 { # A resource containing settings related to reporting identity.
1097 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: &quot;properties/1234/reportingIdentitySettings&quot;
1098 &quot;reportingIdentity&quot;: &quot;A String&quot;, # The strategy used for identifying user identities in reports.
1099 }
1100
1101 updateMask: string, Optional. The list of fields to be updated. Field names must be in snake case (for example, &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. If omitted, the service will treat it as an implied field mask equivalent to all fields that are populated.
1102 x__xgafv: string, V1 error format.
1103 Allowed values
1104 1 - v1 error format
1105 2 - v2 error format
1106
1107 Returns:
1108 An object of the form:
1109
1110 { # A resource containing settings related to reporting identity.
1111 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: &quot;properties/1234/reportingIdentitySettings&quot;
1112 &quot;reportingIdentity&quot;: &quot;A String&quot;, # The strategy used for identifying user identities in reports.
1113 }</pre>
1114 </div>
1115
1116 </body></html>