EnhancedMeasurementSettings

  • Enhanced Measurement Settings is a singleton resource under a web DataStream for configuring measurement of additional site interactions and content.

  • It includes boolean fields to enable or disable the measurement of various interactions such as scrolls, outbound clicks, site search, video engagement, file downloads, page changes, and form interactions.

  • The settings include string fields for specifying site search and additional URI query parameters.

  • The name field is output only and represents the resource name of the Enhanced Measurement Settings.

  • The streamEnabled field indicates whether the Enhanced Measurement Settings are active for a web stream.

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.