Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
EnhancedMeasurementSettings
Stay organized with collections
Save and categorize content based on your preferences.
Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
| JSON representation |
{
"name": string,
"streamEnabled": boolean,
"scrollsEnabled": boolean,
"outboundClicksEnabled": boolean,
"siteSearchEnabled": boolean,
"videoEngagementEnabled": boolean,
"fileDownloadsEnabled": boolean,
"pageChangesEnabled": boolean,
"formInteractionsEnabled": boolean,
"searchQueryParameter": string,
"uriQueryParameter": string
} |
| Fields |
name |
string
Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{dataStream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
|
streamEnabled |
boolean
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.
|
scrollsEnabled |
boolean
If enabled, capture scroll events each time a visitor gets to the bottom of a page.
|
outboundClicksEnabled |
boolean
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
|
siteSearchEnabled |
boolean
If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
|
videoEngagementEnabled |
boolean
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
|
fileDownloadsEnabled |
boolean
If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
|
pageChangesEnabled |
boolean
If enabled, capture a page view event each time the website changes the browser history state.
|
formInteractionsEnabled |
boolean
If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.
|
searchQueryParameter |
string
Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.
|
uriQueryParameter |
string
Additional URL query parameters. Max length is 1024 characters.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eEnhanced Measurement Settings automatically track website interactions and content using a web DataStream.\u003c/p\u003e\n"],["\u003cp\u003eThis singular resource provides a variety of configurable settings for measuring events like scrolls, outbound clicks, site search, video engagement, file downloads, page changes, and form interactions.\u003c/p\u003e\n"],["\u003cp\u003eYou can enable or disable the automatic measurement of these interactions while customizing aspects such as site search parameters and additional URL query parameters.\u003c/p\u003e\n"],["\u003cp\u003eResource information and individual interaction settings are represented in JSON format, accessible via a designated endpoint ("properties/{property_id}/dataStreams/{dataStream}/enhancedMeasurementSettings").\u003c/p\u003e\n"]]],["This content describes settings for enhanced measurement of interactions on a web data stream. Key actions include enabling or disabling the use of these settings to measure interactions and content. Specific interactions measured include scrolls, outbound clicks, site searches, video engagement, file downloads, page changes, and form interactions. The settings also capture URL query parameters for site search and allow additional parameters. Each measurement type can be individually turned on or off, with specific settings, such as \"searchQueryParameter\".\n"],null,["# EnhancedMeasurementSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nSingleton resource under a web DataStream, configuring measurement of additional site interactions and content.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"streamEnabled\": boolean, \"scrollsEnabled\": boolean, \"outboundClicksEnabled\": boolean, \"siteSearchEnabled\": boolean, \"videoEngagementEnabled\": boolean, \"fileDownloadsEnabled\": boolean, \"pageChangesEnabled\": boolean, \"formInteractionsEnabled\": boolean, \"searchQueryParameter\": string, \"uriQueryParameter\": string } ``` |\n\n| Fields ||\n|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{dataStream}/enhancedMeasurementSettings Example: \"properties/1000/dataStreams/2000/enhancedMeasurementSettings\" |\n| `streamEnabled` | `boolean` 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. |\n| `scrollsEnabled` | `boolean` If enabled, capture scroll events each time a visitor gets to the bottom of a page. |\n| `outboundClicksEnabled` | `boolean` If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. |\n| `siteSearchEnabled` | `boolean` If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter). |\n| `videoEngagementEnabled` | `boolean` If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. |\n| `fileDownloadsEnabled` | `boolean` If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension. |\n| `pageChangesEnabled` | `boolean` If enabled, capture a page view event each time the website changes the browser history state. |\n| `formInteractionsEnabled` | `boolean` If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. |\n| `searchQueryParameter` | `string` Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. |\n| `uriQueryParameter` | `string` Additional URL query parameters. Max length is 1024 characters. |"]]
