blob: b51aca67964c7a6ccb264303cb8f95a17ead9a33 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="analyticsadmin_v1alpha.html">Google Analytics Admin API</a> . <a href="analyticsadmin_v1alpha.properties.html">properties</a> . <a href="analyticsadmin_v1alpha.properties.webDataStreams.html">webDataStreams</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a web stream with the specified location and attributes.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a web stream on a property.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Lookup for a single WebDataStream Throws "Target not found" if no such web data stream found, or if the caller does not have permissions to access it.</p>
89<p class="toc_element">
90 <code><a href="#getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>
92<p class="toc_element">
93 <code><a href="#getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</a></code></p>
94<p class="firstline">Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.</p>
95<p class="toc_element">
96 <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Updates a web stream on a property.</p>
104<p class="toc_element">
105 <code><a href="#updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
115 <pre>Creates a web stream with the specified location and attributes.
116
117Args:
118 parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required)
119 body: object, The request body.
120 The object takes the form of:
121
122{ # A resource message representing a Google Analytics web stream.
123 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
124 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
125 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
126 &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.
127 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
128 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
129 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
130}
131
132 x__xgafv: string, V1 error format.
133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
136
137Returns:
138 An object of the form:
139
140 { # A resource message representing a Google Analytics web stream.
141 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
142 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
143 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
144 &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.
145 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
146 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
147 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
153 <pre>Deletes a web stream on a property.
154
155Args:
156 name: string, Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/123/webDataStreams/456&quot; (required)
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="get">get(name, x__xgafv=None)</code>
171 <pre>Lookup for a single WebDataStream Throws &quot;Target not found&quot; if no such web data stream found, or if the caller does not have permissions to access it.
172
173Args:
174 name: string, Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/123/webDataStreams/456&quot; (required)
175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
183 { # A resource message representing a Google Analytics web stream.
184 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
185 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
186 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
187 &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.
188 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
189 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
190 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</code>
196 <pre>Returns the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.
197
198Args:
199 name: string, Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: &quot;properties/1000/webDataStreams/2000/enhancedMeasurementSettings&quot; (required)
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205Returns:
206 An object of the form:
207
208 { # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
209 &quot;productsAndEcommerceEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has product details screens, etc.
210 &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.
211 &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).
212 &quot;excludedDomains&quot;: &quot;A String&quot;, # Domains to exclude from measurement. Max length is 1024 characters.
213 &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.
214 &quot;articlesAndBlogsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has articles or blog posts.
215 &quot;urlQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
216 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.
217 &quot;contentViewsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).
218 &quot;pageViewsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.
219 &quot;dataTaggedElementClicksEnabled&quot;: True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with &quot;data-ga&quot;.
220 &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.
221 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: &quot;properties/1000/webDataStreams/2000/enhancedMeasurementSettings&quot;
222 &quot;pageLoadsEnabled&quot;: True or False, # If enabled, capture a page view event each time a page loads.
223 &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.
224 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
225 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
226 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
227 }</pre>
228</div>
229
230<div class="method">
231 <code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code>
232 <pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
233
234Args:
235 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}/webDataStreams/{stream_id}/globalSiteTag Example: &quot;properties/123/webDataStreams/456/globalSiteTag&quot; (required)
236 x__xgafv: string, V1 error format.
237 Allowed values
238 1 - v1 error format
239 2 - v2 error format
240
241Returns:
242 An object of the form:
243
244 { # Read-only resource with the tag for sending data from a website to a WebDataStream.
245 &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.
246 }</pre>
247</div>
248
249<div class="method">
250 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
251 <pre>Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
252
253Args:
254 parent: string, Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: &quot;properties/123&quot; (required)
255 pageToken: string, A page token, received from a previous `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` must match the call that provided the page token.
256 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)
257 x__xgafv: string, V1 error format.
258 Allowed values
259 1 - v1 error format
260 2 - v2 error format
261
262Returns:
263 An object of the form:
264
265 { # Request message for ListWebDataStreams RPC.
266 &quot;webDataStreams&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
267 { # A resource message representing a Google Analytics web stream.
268 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
269 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
270 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
271 &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.
272 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
273 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
274 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
275 },
276 ],
277 &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.
278 }</pre>
279</div>
280
281<div class="method">
282 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
283 <pre>Retrieves the next page of results.
284
285Args:
286 previous_request: The request for the previous page. (required)
287 previous_response: The response from the request for the previous page. (required)
288
289Returns:
290 A request object that you can call &#x27;execute()&#x27; on to request the next
291 page. Returns None if there are no more items in the collection.
292 </pre>
293</div>
294
295<div class="method">
296 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
297 <pre>Updates a web stream on a property.
298
299Args:
300 name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot; (required)
301 body: object, The request body.
302 The object takes the form of:
303
304{ # A resource message representing a Google Analytics web stream.
305 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
306 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
307 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
308 &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.
309 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
310 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
311 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
312}
313
314 updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
315 x__xgafv: string, V1 error format.
316 Allowed values
317 1 - v1 error format
318 2 - v2 error format
319
320Returns:
321 An object of the form:
322
323 { # A resource message representing a Google Analytics web stream.
324 &quot;defaultUri&quot;: &quot;A String&quot;, # Immutable. Domain name of the web app being measured, or empty. Example: &quot;http://www.google.com&quot;, &quot;https://www.google.com&quot;
325 &quot;displayName&quot;: &quot;A String&quot;, # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
326 &quot;measurementId&quot;: &quot;A String&quot;, # Output only. Analytics &quot;Measurement ID&quot;, without the &quot;G-&quot; prefix. Example: &quot;G-1A2BCD345E&quot; would just be &quot;1A2BCD345E&quot;
327 &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.
328 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: &quot;properties/1000/webDataStreams/2000&quot;
329 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
330 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
336 <pre>Updates the singleton enhanced measurement settings for this web stream. Note that the stream must enable enhanced measurement for these settings to take effect.
337
338Args:
339 name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: &quot;properties/1000/webDataStreams/2000/enhancedMeasurementSettings&quot; (required)
340 body: object, The request body.
341 The object takes the form of:
342
343{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
344 &quot;productsAndEcommerceEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has product details screens, etc.
345 &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.
346 &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).
347 &quot;excludedDomains&quot;: &quot;A String&quot;, # Domains to exclude from measurement. Max length is 1024 characters.
348 &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.
349 &quot;articlesAndBlogsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has articles or blog posts.
350 &quot;urlQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
351 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.
352 &quot;contentViewsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).
353 &quot;pageViewsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.
354 &quot;dataTaggedElementClicksEnabled&quot;: True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with &quot;data-ga&quot;.
355 &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.
356 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: &quot;properties/1000/webDataStreams/2000/enhancedMeasurementSettings&quot;
357 &quot;pageLoadsEnabled&quot;: True or False, # If enabled, capture a page view event each time a page loads.
358 &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.
359 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
360 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
361 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
362}
363
364 updateMask: string, The list of fields to be updated. Omitted fields will not be updated.
365 x__xgafv: string, V1 error format.
366 Allowed values
367 1 - v1 error format
368 2 - v2 error format
369
370Returns:
371 An object of the form:
372
373 { # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
374 &quot;productsAndEcommerceEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has product details screens, etc.
375 &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.
376 &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).
377 &quot;excludedDomains&quot;: &quot;A String&quot;, # Domains to exclude from measurement. Max length is 1024 characters.
378 &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.
379 &quot;articlesAndBlogsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has articles or blog posts.
380 &quot;urlQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
381 &quot;formInteractionsEnabled&quot;: True or False, # If enabled, capture a view search results event each time a visitor interacts with a form on your site.
382 &quot;contentViewsEnabled&quot;: True or False, # Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.).
383 &quot;pageViewsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state.
384 &quot;dataTaggedElementClicksEnabled&quot;: True or False, # If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with &quot;data-ga&quot;.
385 &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.
386 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: &quot;properties/1000/webDataStreams/2000/enhancedMeasurementSettings&quot;
387 &quot;pageLoadsEnabled&quot;: True or False, # If enabled, capture a page view event each time a page loads.
388 &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.
389 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
390 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
391 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
392 }</pre>
393</div>
394
395</body></html>