blob: 5a158cd886fc531fbfcc9a9b9b0913a34be00b51 [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>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -080088<p class="firstline">Lookup for a single WebDataStream</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070089<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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080096 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800123 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
124 &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;
125 &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.
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;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;
128 &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;
129 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
130}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700131
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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800141 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
142 &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;
143 &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.
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;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;
146 &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;
147 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
148}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700149</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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800166}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700167</div>
168
169<div class="method">
170 <code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800171 <pre>Lookup for a single WebDataStream
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700172
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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800184 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
185 &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;
186 &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.
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;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;
189 &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;
190 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
191}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192</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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800210 &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;
211 &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.
212 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800213 &quot;pageLoadsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800214 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800215 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
216 &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.
217 &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).
218 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800219 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800220 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
221}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222</div>
223
224<div class="method">
225 <code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code>
226 <pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
227
228Args:
229 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)
230 x__xgafv: string, V1 error format.
231 Allowed values
232 1 - v1 error format
233 2 - v2 error format
234
235Returns:
236 An object of the form:
237
238 { # Read-only resource with the tag for sending data from a website to a WebDataStream.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800239 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800240 &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.
241}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700242</div>
243
244<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800245 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700246 <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.
247
248Args:
249 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)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800250 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)
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800251 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700252 x__xgafv: string, V1 error format.
253 Allowed values
254 1 - v1 error format
255 2 - v2 error format
256
257Returns:
258 An object of the form:
259
260 { # Request message for ListWebDataStreams RPC.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 &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.
262 &quot;webDataStreams&quot;: [ # Results that matched the filter criteria and were accessible to the caller.
263 { # A resource message representing a Google Analytics web stream.
264 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
265 &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;
266 &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.
267 &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.
268 &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;
269 &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;
270 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
271 },
272 ],
273}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274</div>
275
276<div class="method">
277 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
278 <pre>Retrieves the next page of results.
279
280Args:
281 previous_request: The request for the previous page. (required)
282 previous_response: The response from the request for the previous page. (required)
283
284Returns:
285 A request object that you can call &#x27;execute()&#x27; on to request the next
286 page. Returns None if there are no more items in the collection.
287 </pre>
288</div>
289
290<div class="method">
291 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
292 <pre>Updates a web stream on a property.
293
294Args:
295 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)
296 body: object, The request body.
297 The object takes the form of:
298
299{ # A resource message representing a Google Analytics web stream.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800300 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
301 &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;
302 &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.
303 &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.
304 &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;
305 &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;
306 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
307}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800309 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700310 x__xgafv: string, V1 error format.
311 Allowed values
312 1 - v1 error format
313 2 - v2 error format
314
315Returns:
316 An object of the form:
317
318 { # A resource message representing a Google Analytics web stream.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800319 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Time when this stream was originally created.
320 &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;
321 &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.
322 &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.
323 &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;
324 &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;
325 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Time when stream payload fields were last updated.
326}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700327</div>
328
329<div class="method">
330 <code class="details" id="updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
331 <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.
332
333Args:
334 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)
335 body: object, The request body.
336 The object takes the form of:
337
338{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800339 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800340 &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;
341 &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.
342 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800343 &quot;pageLoadsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800344 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800345 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
346 &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.
347 &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).
348 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800349 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800350 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
351}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700352
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800353 updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., &quot;field_to_update&quot;). Omitted fields will not be updated. To replace the entire entity, use one path with the string &quot;*&quot; to match all fields.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700354 x__xgafv: string, V1 error format.
355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
358
359Returns:
360 An object of the form:
361
362 { # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800363 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800364 &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;
365 &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.
366 &quot;pageChangesEnabled&quot;: True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800367 &quot;pageLoadsEnabled&quot;: True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800368 &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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;scrollsEnabled&quot;: True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
370 &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.
371 &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).
372 &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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800373 &quot;uriQueryParameter&quot;: &quot;A String&quot;, # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800374 &quot;videoEngagementEnabled&quot;: True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
375}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700376</div>
377
378</body></html>