Class EnhancedMeasurementSettings.Builder (0.56.0) 

public static final class EnhancedMeasurementSettings.Builder extends GeneratedMessageV3.Builder<EnhancedMeasurementSettings.Builder> implements EnhancedMeasurementSettingsOrBuilder

Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.

Protobuf type google.analytics.admin.v1alpha.EnhancedMeasurementSettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > EnhancedMeasurementSettings.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EnhancedMeasurementSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

build()

public EnhancedMeasurementSettings build()
Returns
Type Description
EnhancedMeasurementSettings

buildPartial()

public EnhancedMeasurementSettings buildPartial()
Returns
Type Description
EnhancedMeasurementSettings

clear()

public EnhancedMeasurementSettings.Builder clear()
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public EnhancedMeasurementSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

clearFileDownloadsEnabled()

public EnhancedMeasurementSettings.Builder clearFileDownloadsEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearFormInteractionsEnabled()

public EnhancedMeasurementSettings.Builder clearFormInteractionsEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearName()

public EnhancedMeasurementSettings.Builder clearName()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EnhancedMeasurementSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

clearOutboundClicksEnabled()

public EnhancedMeasurementSettings.Builder clearOutboundClicksEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearPageChangesEnabled()

public EnhancedMeasurementSettings.Builder clearPageChangesEnabled()

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

bool page_changes_enabled = 8;

Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearScrollsEnabled()

public EnhancedMeasurementSettings.Builder clearScrollsEnabled()

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

bool scrolls_enabled = 3;

Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearSearchQueryParameter()

public EnhancedMeasurementSettings.Builder clearSearchQueryParameter()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearSiteSearchEnabled()

public EnhancedMeasurementSettings.Builder clearSiteSearchEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearStreamEnabled()

public EnhancedMeasurementSettings.Builder clearStreamEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearUriQueryParameter()

public EnhancedMeasurementSettings.Builder clearUriQueryParameter()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

clearVideoEngagementEnabled()

public EnhancedMeasurementSettings.Builder clearVideoEngagementEnabled()

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
EnhancedMeasurementSettings.Builder

This builder for chaining.

clone()

public EnhancedMeasurementSettings.Builder clone()
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

getDefaultInstanceForType()

public EnhancedMeasurementSettings getDefaultInstanceForType()
Returns
Type Description
EnhancedMeasurementSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFileDownloadsEnabled()

public 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 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 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 ByteString getNameBytes()

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
ByteString

The bytes for name.

getOutboundClicksEnabled()

public 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 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 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 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 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 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 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 String getUriQueryParameter()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
Type Description
String

The uriQueryParameter.

getUriQueryParameterBytes()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EnhancedMeasurementSettings other)

public EnhancedMeasurementSettings.Builder mergeFrom(EnhancedMeasurementSettings other)
Parameter
Name Description
other EnhancedMeasurementSettings
Returns
Type Description
EnhancedMeasurementSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EnhancedMeasurementSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EnhancedMeasurementSettings.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EnhancedMeasurementSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public EnhancedMeasurementSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

setFileDownloadsEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setFileDownloadsEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The fileDownloadsEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setFormInteractionsEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setFormInteractionsEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The formInteractionsEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setName(String value)

public EnhancedMeasurementSettings.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setNameBytes(ByteString value)

public EnhancedMeasurementSettings.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setOutboundClicksEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setOutboundClicksEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The outboundClicksEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setPageChangesEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setPageChangesEnabled(boolean value)

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

bool page_changes_enabled = 8;

Parameter
Name Description
value boolean

The pageChangesEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EnhancedMeasurementSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

setScrollsEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setScrollsEnabled(boolean value)

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

bool scrolls_enabled = 3;

Parameter
Name Description
value boolean

The scrollsEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setSearchQueryParameter(String value)

public EnhancedMeasurementSettings.Builder setSearchQueryParameter(String value)

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];

Parameter
Name Description
value String

The searchQueryParameter to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setSearchQueryParameterBytes(ByteString value)

public EnhancedMeasurementSettings.Builder setSearchQueryParameterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for searchQueryParameter to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setSiteSearchEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setSiteSearchEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The siteSearchEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setStreamEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setStreamEnabled(boolean value)

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;

Parameter
Name Description
value boolean

The streamEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EnhancedMeasurementSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EnhancedMeasurementSettings.Builder
Overrides

setUriQueryParameter(String value)

public EnhancedMeasurementSettings.Builder setUriQueryParameter(String value)

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Parameter
Name Description
value String

The uriQueryParameter to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setUriQueryParameterBytes(ByteString value)

public EnhancedMeasurementSettings.Builder setUriQueryParameterBytes(ByteString value)

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Parameter
Name Description
value ByteString

The bytes for uriQueryParameter to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.

setVideoEngagementEnabled(boolean value)

public EnhancedMeasurementSettings.Builder setVideoEngagementEnabled(boolean value)

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

bool video_engagement_enabled = 6;

Parameter
Name Description
value boolean

The videoEngagementEnabled to set.
Returns
Type Description
EnhancedMeasurementSettings.Builder

This builder for chaining.