Class EnhancedMeasurementSettings (0.31.0)

Version 0.31.0

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.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

Inheritance

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

Implements

EnhancedMeasurementSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FILE_DOWNLOADS_ENABLED_FIELD_NUMBER

public static final int FILE_DOWNLOADS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

FORM_INTERACTIONS_ENABLED_FIELD_NUMBER

public static final int FORM_INTERACTIONS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER

public static final int OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_CHANGES_ENABLED_FIELD_NUMBER

public static final int PAGE_CHANGES_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

SCROLLS_ENABLED_FIELD_NUMBER

public static final int SCROLLS_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_QUERY_PARAMETER_FIELD_NUMBER

public static final int SEARCH_QUERY_PARAMETER_FIELD_NUMBER

Field Value
Type	Description
int

SITE_SEARCH_ENABLED_FIELD_NUMBER

public static final int SITE_SEARCH_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

STREAM_ENABLED_FIELD_NUMBER

public static final int STREAM_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

URI_QUERY_PARAMETER_FIELD_NUMBER

public static final int URI_QUERY_PARAMETER_FIELD_NUMBER

Field Value
Type	Description
int

VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER

public static final int VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static EnhancedMeasurementSettings getDefaultInstance()

Returns
Type	Description
EnhancedMeasurementSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static EnhancedMeasurementSettings.Builder newBuilder()

Returns
Type	Description
EnhancedMeasurementSettings.Builder

newBuilder(EnhancedMeasurementSettings prototype)

public static EnhancedMeasurementSettings.Builder newBuilder(EnhancedMeasurementSettings prototype)

Parameter
Name	Description
prototype	EnhancedMeasurementSettings

Returns
Type	Description
EnhancedMeasurementSettings.Builder

parseDelimitedFrom(InputStream input)

public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static EnhancedMeasurementSettings parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EnhancedMeasurementSettings parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EnhancedMeasurementSettings parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static EnhancedMeasurementSettings parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static EnhancedMeasurementSettings parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EnhancedMeasurementSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EnhancedMeasurementSettings

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<EnhancedMeasurementSettings> parser()

Returns
Type	Description
Parser<EnhancedMeasurementSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public EnhancedMeasurementSettings getDefaultInstanceForType()

Returns
Type	Description
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
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.

getParserForType()

public Parser<EnhancedMeasurementSettings> getParserForType()

Returns
Type	Description
Parser<EnhancedMeasurementSettings>

Overrides

GeneratedMessageV3.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public EnhancedMeasurementSettings.Builder newBuilderForType()

Returns
Type	Description
EnhancedMeasurementSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EnhancedMeasurementSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
EnhancedMeasurementSettings.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public EnhancedMeasurementSettings.Builder toBuilder()

Returns
Type	Description
EnhancedMeasurementSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException