Reference documentation and code samples for the Google Analytics Admin V1alpha Client class EnhancedMeasurementSettings.
Singleton resource under a WebDataStream, configuring measurement of additional site interactions and content.
Generated from protobuf message google.analytics.admin.v1alpha.EnhancedMeasurementSettings
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" |
↳ stream_enabled |
bool
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. |
↳ scrolls_enabled |
bool
If enabled, capture scroll events each time a visitor gets to the bottom of a page. |
↳ outbound_clicks_enabled |
bool
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. |
↳ site_search_enabled |
bool
If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter). |
↳ video_engagement_enabled |
bool
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. |
↳ file_downloads_enabled |
bool
If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension. |
↳ page_changes_enabled |
bool
If enabled, capture a page view event each time the website changes the browser history state. |
↳ form_interactions_enabled |
bool
If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. |
↳ search_query_parameter |
string
Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. |
↳ uri_query_parameter |
string
Additional URL query parameters. Max length is 1024 characters. |
getName
Output only. Resource name of the Enhanced Measurement Settings.
Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. Resource name of the Enhanced Measurement Settings.
Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStreamEnabled
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.
| Returns | |
|---|---|
| Type | Description |
bool | |
setStreamEnabled
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getScrollsEnabled
If enabled, capture scroll events each time a visitor gets to the bottom of a page.
| Returns | |
|---|---|
| Type | Description |
bool | |
setScrollsEnabled
If enabled, capture scroll events each time a visitor gets to the bottom of a page.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutboundClicksEnabled
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
| Returns | |
|---|---|
| Type | Description |
bool | |
setOutboundClicksEnabled
If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSiteSearchEnabled
If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
| Returns | |
|---|---|
| Type | Description |
bool | |
setSiteSearchEnabled
If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVideoEngagementEnabled
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
| Returns | |
|---|---|
| Type | Description |
bool | |
setVideoEngagementEnabled
If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFileDownloadsEnabled
If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
| Returns | |
|---|---|
| Type | Description |
bool | |
setFileDownloadsEnabled
If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageChangesEnabled
If enabled, capture a page view event each time the website changes the browser history state.
| Returns | |
|---|---|
| Type | Description |
bool | |
setPageChangesEnabled
If enabled, capture a page view event each time the website changes the browser history state.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFormInteractionsEnabled
If enabled, capture a form interaction event each time a visitor interacts with a form on your website.
False by default.
| Returns | |
|---|---|
| Type | Description |
bool | |
setFormInteractionsEnabled
If enabled, capture a form interaction event each time a visitor interacts with a form on your website.
False by default.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSearchQueryParameter
Required. URL query parameters to interpret as site search parameters.
Max length is 1024 characters. Must not be empty.
| Returns | |
|---|---|
| Type | Description |
string | |
setSearchQueryParameter
Required. URL query parameters to interpret as site search parameters.
Max length is 1024 characters. Must not be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUriQueryParameter
Additional URL query parameters.
Max length is 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setUriQueryParameter
Additional URL query parameters.
Max length is 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |