Interface EnhancedMeasurementSettingsOrBuilder (0.31.0)

public interface EnhancedMeasurementSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFileDownloadsEnabled()

public abstract boolean 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.

bool file_downloads_enabled = 7;

Returns
Type	Description
`boolean`	The fileDownloadsEnabled.

getFormInteractionsEnabled()

public abstract boolean getFormInteractionsEnabled()

If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default.

bool form_interactions_enabled = 9;

Returns
Type	Description
`boolean`	The formInteractionsEnabled.

getName()

public abstract String getName()

Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getOutboundClicksEnabled()

public abstract boolean getOutboundClicksEnabled()

If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.

bool outbound_clicks_enabled = 4;

Returns
Type	Description
`boolean`	The outboundClicksEnabled.

getPageChangesEnabled()

public abstract boolean getPageChangesEnabled()

If enabled, capture a page view event each time the website changes the browser history state.

bool page_changes_enabled = 8;

Returns
Type	Description
`boolean`	The pageChangesEnabled.

getScrollsEnabled()

public abstract boolean getScrollsEnabled()

If enabled, capture scroll events each time a visitor gets to the bottom of a page.

bool scrolls_enabled = 3;

Returns
Type	Description
`boolean`	The scrollsEnabled.

getSearchQueryParameter()

public abstract String getSearchQueryParameter()

Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

string search_query_parameter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The searchQueryParameter.

getSearchQueryParameterBytes()

public abstract ByteString getSearchQueryParameterBytes()

Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty.

string search_query_parameter = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for searchQueryParameter.

getSiteSearchEnabled()

public abstract boolean getSiteSearchEnabled()

If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter).

bool site_search_enabled = 5;

Returns
Type	Description
`boolean`	The siteSearchEnabled.

getStreamEnabled()

public abstract boolean 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.

bool stream_enabled = 2;

Returns
Type	Description
`boolean`	The streamEnabled.

getUriQueryParameter()

public abstract String getUriQueryParameter()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
Type	Description
`String`	The uriQueryParameter.

getUriQueryParameterBytes()

public abstract ByteString getUriQueryParameterBytes()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
Type	Description
`ByteString`	The bytes for uriQueryParameter.

getVideoEngagementEnabled()

public abstract boolean getVideoEngagementEnabled()

If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

bool video_engagement_enabled = 6;

Returns
Type	Description
`boolean`	The videoEngagementEnabled.