Debian Codegraph @

docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.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> . <a href="analyticsadmin_v1alpha.properties.dataStreams.html">dataStreams</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="analyticsadmin_v1alpha.properties.dataStreams.eventCreateRules.html">eventCreateRules()</a></code>
79 </p>
80 <p class="firstline">Returns the eventCreateRules Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="analyticsadmin_v1alpha.properties.dataStreams.eventEditRules.html">eventEditRules()</a></code>
84 </p>
85 <p class="firstline">Returns the eventEditRules Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="analyticsadmin_v1alpha.properties.dataStreams.measurementProtocolSecrets.html">measurementProtocolSecrets()</a></code>
89 </p>
90 <p class="firstline">Returns the measurementProtocolSecrets Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="analyticsadmin_v1alpha.properties.dataStreams.sKAdNetworkConversionValueSchema.html">sKAdNetworkConversionValueSchema()</a></code>
94 </p>
95 <p class="firstline">Returns the sKAdNetworkConversionValueSchema Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="#close">close()</a></code></p>
99 <p class="firstline">Close httplib2 connections.</p>
100 <p class="toc_element">
101 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Creates a DataStream.</p>
103 <p class="toc_element">
104 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
105 <p class="firstline">Deletes a DataStream on a property.</p>
106 <p class="toc_element">
107 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
108 <p class="firstline">Lookup for a single DataStream.</p>
109 <p class="toc_element">
110 <code><a href="#getDataRedactionSettings">getDataRedactionSettings(name, x__xgafv=None)</a></code></p>
111 <p class="firstline">Lookup for a single DataRedactionSettings.</p>
112 <p class="toc_element">
113 <code><a href="#getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</a></code></p>
114 <p class="firstline">Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>
115 <p class="toc_element">
116 <code><a href="#getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</a></code></p>
117 <p class="firstline">Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.</p>
118 <p class="toc_element">
119 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
120 <p class="firstline">Lists DataStreams on a property.</p>
121 <p class="toc_element">
122 <code><a href="#list_next">list_next()</a></code></p>
123 <p class="firstline">Retrieves the next page of results.</p>
124 <p class="toc_element">
125 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
126 <p class="firstline">Updates a DataStream on a property.</p>
127 <p class="toc_element">
128 <code><a href="#updateDataRedactionSettings">updateDataRedactionSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
129 <p class="firstline">Updates a DataRedactionSettings on a property.</p>
130 <p class="toc_element">
131 <code><a href="#updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
132 <p class="firstline">Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>
133 <h3>Method Details</h3>
134 <div class="method">
135 <code class="details" id="close">close()</code>
136 <pre>Close httplib2 connections.</pre>
137 </div>
138
139 <div class="method">
140 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
141 <pre>Creates a DataStream.
142
143 Args:
144 parent: string, Required. Example format: properties/1234 (required)
145 body: object, The request body.
146 The object takes the form of:
147
148 { # A resource message representing a data stream.
149 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
150 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
151 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
152 },
153 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
154 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
155 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
156 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
157 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
158 },
159 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
160 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
161 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
162 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
163 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
164 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
165 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
166 },
167 }
168
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174 Returns:
175 An object of the form:
176
177 { # A resource message representing a data stream.
178 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
179 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
180 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
181 },
182 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
183 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
184 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
185 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
186 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
187 },
188 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
189 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
190 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
191 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
192 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
193 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
194 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
195 },
196 }</pre>
197 </div>
198
199 <div class="method">
200 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
201 <pre>Deletes a DataStream on a property.
202
203 Args:
204 name: string, Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 (required)
205 x__xgafv: string, V1 error format.
206 Allowed values
207 1 - v1 error format
208 2 - v2 error format
209
210 Returns:
211 An object of the form:
212
213 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
214 }</pre>
215 </div>
216
217 <div class="method">
218 <code class="details" id="get">get(name, x__xgafv=None)</code>
219 <pre>Lookup for a single DataStream.
220
221 Args:
222 name: string, Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 (required)
223 x__xgafv: string, V1 error format.
224 Allowed values
225 1 - v1 error format
226 2 - v2 error format
227
228 Returns:
229 An object of the form:
230
231 { # A resource message representing a data stream.
232 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
233 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
234 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
235 },
236 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
237 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
238 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
239 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
240 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
241 },
242 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
243 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
244 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
245 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
246 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
247 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
248 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
249 },
250 }</pre>
251 </div>
252
253 <div class="method">
254 <code class="details" id="getDataRedactionSettings">getDataRedactionSettings(name, x__xgafv=None)</code>
255 <pre>Lookup for a single DataRedactionSettings.
256
257 Args:
258 name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: &quot;properties/1000/dataStreams/2000/dataRedactionSettings&quot; (required)
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 { # Settings for client-side data redaction. Singleton resource under a Web Stream.
268 &quot;emailRedactionEnabled&quot;: True or False, # If enabled, any event parameter or user property values that look like an email will be redacted.
269 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: &quot;properties/1000/dataStreams/2000/dataRedactionSettings&quot;
270 &quot;queryParameterKeys&quot;: [ # The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.
271 &quot;A String&quot;,
272 ],
273 &quot;queryParameterRedactionEnabled&quot;: True or False, # Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.
274 }</pre>
275 </div>
276
277 <div class="method">
278 <code class="details" id="getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</code>
279 <pre>Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
280
281 Args:
282 name: string, Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: &quot;properties/1000/dataStreams/2000/enhancedMeasurementSettings&quot; (required)
283 x__xgafv: string, V1 error format.
284 Allowed values
285 1 - v1 error format
286 2 - v2 error format
287
288 Returns:
289 An object of the form:
290
291 { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
292 &quot;fileDownloadsEnabled&quot;: True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
293 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
294 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: &quot;properties/1000/dataStreams/2000/enhancedMeasurementSettings&quot;
295 &quot;outboundClicksEnabled&quot;: True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
296 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
297 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
298 &quot;searchQueryParameter&quot;: &quot;A String&quot;, # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
299 &quot;siteSearchEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
300 &quot;streamEnabled&quot;: True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.
301 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
302 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
303 }</pre>
304 </div>
305
306 <div class="method">
307 <code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code>
308 <pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
309
310 Args:
311 name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag` (required)
312 x__xgafv: string, V1 error format.
313 Allowed values
314 1 - v1 error format
315 2 - v2 error format
316
317 Returns:
318 An object of the form:
319
320 { # Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
321 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: &quot;properties/123/dataStreams/456/globalSiteTag&quot;
322 &quot;snippet&quot;: &quot;A String&quot;, # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.
323 }</pre>
324 </div>
325
326 <div class="method">
327 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
328 <pre>Lists DataStreams on a property.
329
330 Args:
331 parent: string, Required. Example format: properties/1234 (required)
332 pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
333 pageToken: string, A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token.
334 x__xgafv: string, V1 error format.
335 Allowed values
336 1 - v1 error format
337 2 - v2 error format
338
339 Returns:
340 An object of the form:
341
342 { # Response message for ListDataStreams RPC.
343 &quot;dataStreams&quot;: [ # List of DataStreams.
344 { # A resource message representing a data stream.
345 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
346 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
347 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
348 },
349 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
350 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
351 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
352 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
353 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
354 },
355 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
356 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
357 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
358 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
359 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
360 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
361 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
362 },
363 },
364 ],
365 &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.
366 }</pre>
367 </div>
368
369 <div class="method">
370 <code class="details" id="list_next">list_next()</code>
371 <pre>Retrieves the next page of results.
372
373 Args:
374 previous_request: The request for the previous page. (required)
375 previous_response: The response from the request for the previous page. (required)
376
377 Returns:
378 A request object that you can call &#x27;execute()&#x27; on to request the next
379 page. Returns None if there are no more items in the collection.
380 </pre>
381 </div>
382
383 <div class="method">
384 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
385 <pre>Updates a DataStream on a property.
386
387 Args:
388 name: string, Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot; (required)
389 body: object, The request body.
390 The object takes the form of:
391
392 { # A resource message representing a data stream.
393 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
394 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
395 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
396 },
397 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
398 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
399 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
400 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
401 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
402 },
403 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
404 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
405 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
406 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
407 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
408 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
409 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
410 },
411 }
412
413 updateMask: string, Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
414 x__xgafv: string, V1 error format.
415 Allowed values
416 1 - v1 error format
417 2 - v2 error format
418
419 Returns:
420 An object of the form:
421
422 { # A resource message representing a data stream.
423 &quot;androidAppStreamData&quot;: { # Data specific to Android app streams. # Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.
424 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.
425 &quot;packageName&quot;: &quot;A String&quot;, # Immutable. The package name for the app being measured. Example: &quot;com.example.myandroidapp&quot;
426 },
427 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
428 &quot;displayName&quot;: &quot;A String&quot;, # Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.
429 &quot;iosAppStreamData&quot;: { # Data specific to iOS app streams. # Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.
430 &quot;bundleId&quot;: &quot;A String&quot;, # Required. Immutable. The Apple App Store Bundle ID for the app Example: &quot;com.example.myiosapp&quot;
431 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.
432 },
433 &quot;name&quot;: &quot;A String&quot;, # Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: &quot;properties/1000/dataStreams/2000&quot;
434 &quot;type&quot;: &quot;A String&quot;, # Required. Immutable. The type of this DataStream resource.
435 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
436 &quot;webStreamData&quot;: { # Data specific to web streams. # Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
437 &quot;defaultUri&quot;: &quot;A String&quot;, # Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
438 &quot;firebaseAppId&quot;: &quot;A String&quot;, # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
439 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics Measurement ID. Example: &quot;G-1A2BCD345E&quot;
440 },
441 }</pre>
442 </div>
443
444 <div class="method">
445 <code class="details" id="updateDataRedactionSettings">updateDataRedactionSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
446 <pre>Updates a DataRedactionSettings on a property.
447
448 Args:
449 name: string, Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: &quot;properties/1000/dataStreams/2000/dataRedactionSettings&quot; (required)
450 body: object, The request body.
451 The object takes the form of:
452
453 { # Settings for client-side data redaction. Singleton resource under a Web Stream.
454 &quot;emailRedactionEnabled&quot;: True or False, # If enabled, any event parameter or user property values that look like an email will be redacted.
455 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: &quot;properties/1000/dataStreams/2000/dataRedactionSettings&quot;
456 &quot;queryParameterKeys&quot;: [ # The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.
457 &quot;A String&quot;,
458 ],
459 &quot;queryParameterRedactionEnabled&quot;: True or False, # Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.
460 }
461
462 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.
463 x__xgafv: string, V1 error format.
464 Allowed values
465 1 - v1 error format
466 2 - v2 error format
467
468 Returns:
469 An object of the form:
470
471 { # Settings for client-side data redaction. Singleton resource under a Web Stream.
472 &quot;emailRedactionEnabled&quot;: True or False, # If enabled, any event parameter or user property values that look like an email will be redacted.
473 &quot;name&quot;: &quot;A String&quot;, # Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: &quot;properties/1000/dataStreams/2000/dataRedactionSettings&quot;
474 &quot;queryParameterKeys&quot;: [ # The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.
475 &quot;A String&quot;,
476 ],
477 &quot;queryParameterRedactionEnabled&quot;: True or False, # Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.
478 }</pre>
479 </div>
480
481 <div class="method">
482 <code class="details" id="updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
483 <pre>Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.
484
485 Args:
486 name: string, Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: &quot;properties/1000/dataStreams/2000/enhancedMeasurementSettings&quot; (required)
487 body: object, The request body.
488 The object takes the form of:
489
490 { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
491 &quot;fileDownloadsEnabled&quot;: True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
492 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
493 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: &quot;properties/1000/dataStreams/2000/enhancedMeasurementSettings&quot;
494 &quot;outboundClicksEnabled&quot;: True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
495 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
496 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
497 &quot;searchQueryParameter&quot;: &quot;A String&quot;, # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
498 &quot;siteSearchEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
499 &quot;streamEnabled&quot;: True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.
500 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
501 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
502 }
503
504 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.
505 x__xgafv: string, V1 error format.
506 Allowed values
507 1 - v1 error format
508 2 - v2 error format
509
510 Returns:
511 An object of the form:
512
513 { # Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
514 &quot;fileDownloadsEnabled&quot;: True or False, # If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
515 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
516 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: &quot;properties/1000/dataStreams/2000/enhancedMeasurementSettings&quot;
517 &quot;outboundClicksEnabled&quot;: True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
518 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
519 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
520 &quot;searchQueryParameter&quot;: &quot;A String&quot;, # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
521 &quot;siteSearchEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
522 &quot;streamEnabled&quot;: True or False, # Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected.
523 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
524 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
525 }</pre>
526 </div>
527
528 </body></html>