Class EnhancedMeasurementSettings (0.31.0)

public final class EnhancedMeasurementSettings extends GeneratedMessageV3 implements EnhancedMeasurementSettingsOrBuilder

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

Protobuf type google.analytics.admin.v1alpha.EnhancedMeasurementSettings

Static Fields

FILE_DOWNLOADS_ENABLED_FIELD_NUMBER

public static final int FILE_DOWNLOADS_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

FORM_INTERACTIONS_ENABLED_FIELD_NUMBER

public static final int FORM_INTERACTIONS_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER

public static final int OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_CHANGES_ENABLED_FIELD_NUMBER

public static final int PAGE_CHANGES_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

SCROLLS_ENABLED_FIELD_NUMBER

public static final int SCROLLS_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

SEARCH_QUERY_PARAMETER_FIELD_NUMBER

public static final int SEARCH_QUERY_PARAMETER_FIELD_NUMBER
Field Value
TypeDescription
int

SITE_SEARCH_ENABLED_FIELD_NUMBER

public static final int SITE_SEARCH_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

STREAM_ENABLED_FIELD_NUMBER

public static final int STREAM_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

URI_QUERY_PARAMETER_FIELD_NUMBER

public static final int URI_QUERY_PARAMETER_FIELD_NUMBER
Field Value
TypeDescription
int

VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER

public static final int VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EnhancedMeasurementSettings getDefaultInstance()
Returns
TypeDescription
EnhancedMeasurementSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EnhancedMeasurementSettings.Builder newBuilder()
Returns
TypeDescription
EnhancedMeasurementSettings.Builder

newBuilder(EnhancedMeasurementSettings prototype)

public static EnhancedMeasurementSettings.Builder newBuilder(EnhancedMeasurementSettings prototype)
Parameter
NameDescription
prototypeEnhancedMeasurementSettings
Returns
TypeDescription
EnhancedMeasurementSettings.Builder

parseDelimitedFrom(InputStream input)

public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EnhancedMeasurementSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EnhancedMeasurementSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EnhancedMeasurementSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EnhancedMeasurementSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EnhancedMeasurementSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EnhancedMeasurementSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EnhancedMeasurementSettings> parser()
Returns
TypeDescription
Parser<EnhancedMeasurementSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EnhancedMeasurementSettings getDefaultInstanceForType()
Returns
TypeDescription
EnhancedMeasurementSettings

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The pageChangesEnabled.

getParserForType()

public Parser<EnhancedMeasurementSettings> getParserForType()
Returns
TypeDescription
Parser<EnhancedMeasurementSettings>
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for searchQueryParameter.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
boolean

The streamEnabled.

getUriQueryParameter()

public String getUriQueryParameter()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
TypeDescription
String

The uriQueryParameter.

getUriQueryParameterBytes()

public ByteString getUriQueryParameterBytes()

Additional URL query parameters. Max length is 1024 characters.

string uri_query_parameter = 11;

Returns
TypeDescription
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
TypeDescription
boolean

The videoEngagementEnabled.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EnhancedMeasurementSettings.Builder newBuilderForType()
Returns
TypeDescription
EnhancedMeasurementSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EnhancedMeasurementSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EnhancedMeasurementSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EnhancedMeasurementSettings.Builder toBuilder()
Returns
TypeDescription
EnhancedMeasurementSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException