Blame - docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html - platform/external/python/google-api-python-client

blob: 29642f2663b10a9d25574ce36e79ec3a490b00d1 [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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.webDataStreams.html">webDataStreams</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	7700bbf	2021-05-20 04:44:03 -0700	[diff] [blame^]	78	<code><a href="analyticsadmin_v1alpha.properties.webDataStreams.measurementProtocolSecrets.html">measurementProtocolSecrets()</a></code>
				79	</p>
				80	<p class="firstline">Returns the measurementProtocolSecrets Resource.</p>
				81
				82	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	83	<code><a href="#close">close()</a></code></p>
				84	<p class="firstline">Close httplib2 connections.</p>
				85	<p class="toc_element">
				86	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Creates a web stream with the specified location and attributes.</p>
				88	<p class="toc_element">
				89	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Deletes a web stream on a property.</p>
				91	<p class="toc_element">
				92	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	93	<p class="firstline">Lookup for a single WebDataStream</p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="toc_element">
				95	<code><a href="#getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</a></code></p>
				96	<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>
				97	<p class="toc_element">
				98	<code><a href="#getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</a></code></p>
				99	<p class="firstline">Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.</p>
				100	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	101	<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<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>
				103	<p class="toc_element">
				104	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				105	<p class="firstline">Retrieves the next page of results.</p>
				106	<p class="toc_element">
				107	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				108	<p class="firstline">Updates a web stream on a property.</p>
				109	<p class="toc_element">
				110	<code><a href="#updateEnhancedMeasurementSettings">updateEnhancedMeasurementSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
				111	<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>
				112	<h3>Method Details</h3>
				113	<div class="method">
				114	<code class="details" id="close">close()</code>
				115	<pre>Close httplib2 connections.</pre>
				116	</div>
				117
				118	<div class="method">
				119	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
				120	<pre>Creates a web stream with the specified location and attributes.
				121
				122	Args:
				123	parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required)
				124	body: object, The request body.
				125	The object takes the form of:
				126
				127	{ # A resource message representing a Google Analytics web stream.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	128	"createTime": "A String", # Output only. Time when this stream was originally created.
				129	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				130	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				131	"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
				132	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				133	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				134	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				135	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	136
				137	x__xgafv: string, V1 error format.
				138	Allowed values
				139	1 - v1 error format
				140	2 - v2 error format
				141
				142	Returns:
				143	An object of the form:
				144
				145	{ # A resource message representing a Google Analytics web stream.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	146	"createTime": "A String", # Output only. Time when this stream was originally created.
				147	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				148	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				149	"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
				150	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				151	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				152	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				153	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	154	</div>
				155
				156	<div class="method">
				157	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
				158	<pre>Deletes a web stream on a property.
				159
				160	Args:
				161	name: string, Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required)
				162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
				166
				167	Returns:
				168	An object of the form:
				169
				170	{ # 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	171	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	172	</div>
				173
				174	<div class="method">
				175	<code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	176	<pre>Lookup for a single WebDataStream
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	177
				178	Args:
				179	name: string, Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required)
				180	x__xgafv: string, V1 error format.
				181	Allowed values
				182	1 - v1 error format
				183	2 - v2 error format
				184
				185	Returns:
				186	An object of the form:
				187
				188	{ # A resource message representing a Google Analytics web stream.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	189	"createTime": "A String", # Output only. Time when this stream was originally created.
				190	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				191	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				192	"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
				193	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				194	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				195	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				196	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	197	</div>
				198
				199	<div class="method">
				200	<code class="details" id="getEnhancedMeasurementSettings">getEnhancedMeasurementSettings(name, x__xgafv=None)</code>
				201	<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.
				202
				203	Args:
				204	name: string, Required. The name of the settings to lookup. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" (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	{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	214	"fileDownloadsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	215	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
				216	"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
				217	"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	218	"pageLoadsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	219	"pageViewsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	220	"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
				221	"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
				222	"siteSearchEnabled": 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).
				223	"streamEnabled": 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-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	224	"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
				226	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	227	</div>
				228
				229	<div class="method">
				230	<code class="details" id="getGlobalSiteTag">getGlobalSiteTag(name, x__xgafv=None)</code>
				231	<pre>Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
				232
				233	Args:
				234	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: "properties/123/webDataStreams/456/globalSiteTag" (required)
				235	x__xgafv: string, V1 error format.
				236	Allowed values
				237	1 - v1 error format
				238	2 - v2 error format
				239
				240	Returns:
				241	An object of the form:
				242
				243	{ # Read-only resource with the tag for sending data from a website to a WebDataStream.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	244	"name": "A String", # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	245	"snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.
				246	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	247	</div>
				248
				249	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	250	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
				253	Args:
				254	parent: string, Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123" (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	255	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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	256	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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	257	x__xgafv: string, V1 error format.
				258	Allowed values
				259	1 - v1 error format
				260	2 - v2 error format
				261
				262	Returns:
				263	An object of the form:
				264
				265	{ # Request message for ListWebDataStreams RPC.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	266	"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
				267	"webDataStreams": [ # Results that matched the filter criteria and were accessible to the caller.
				268	{ # A resource message representing a Google Analytics web stream.
				269	"createTime": "A String", # Output only. Time when this stream was originally created.
				270	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				271	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				272	"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.
				273	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				274	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				275	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				276	},
				277	],
				278	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
				285	Args:
				286	previous_request: The request for the previous page. (required)
				287	previous_response: The response from the request for the previous page. (required)
				288
				289	Returns:
				290	A request object that you can call 'execute()' 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
				299	Args:
				300	name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" (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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	305	"createTime": "A String", # Output only. Time when this stream was originally created.
				306	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				307	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				308	"firebaseAppId": "A String", # 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	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				310	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				311	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				312	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	313
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	314	updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	315	x__xgafv: string, V1 error format.
				316	Allowed values
				317	1 - v1 error format
				318	2 - v2 error format
				319
				320	Returns:
				321	An object of the form:
				322
				323	{ # A resource message representing a Google Analytics web stream.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	324	"createTime": "A String", # Output only. Time when this stream was originally created.
				325	"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"
				326	"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.
				327	"firebaseAppId": "A String", # 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	"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"
				329	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"
				330	"updateTime": "A String", # Output only. Time when stream payload fields were last updated.
				331	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
				338	Args:
				339	name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings" (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.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	344	"fileDownloadsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	345	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
				346	"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
				347	"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	348	"pageLoadsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	349	"pageViewsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	350	"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
				351	"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
				352	"siteSearchEnabled": 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).
				353	"streamEnabled": 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-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	354	"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	355	"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
				356	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	357
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	358	updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	359	x__xgafv: string, V1 error format.
				360	Allowed values
				361	1 - v1 error format
				362	2 - v2 error format
				363
				364	Returns:
				365	An object of the form:
				366
				367	{ # Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	368	"fileDownloadsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	369	"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id}/enhancedMeasurementSettings Example: "properties/1000/webDataStreams/2000/enhancedMeasurementSettings"
				370	"outboundClicksEnabled": True or False, # If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
				371	"pageChangesEnabled": True or False, # If enabled, capture a page view event each time the website changes the browser history state.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	372	"pageLoadsEnabled": True or False, # Output only. If enabled, capture a page view event each time a page loads.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	373	"pageViewsEnabled": 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 Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	"scrollsEnabled": True or False, # If enabled, capture scroll events each time a visitor gets to the bottom of a page.
				375	"searchQueryParameter": "A String", # Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
				376	"siteSearchEnabled": 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	"streamEnabled": 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-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	378	"uriQueryParameter": "A String", # Additional URL query parameters. Max length is 1024 characters.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	379	"videoEngagementEnabled": True or False, # If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
				380	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	381	</div>
				382
				383	</body></html>