Send feedback
Class EnhancedMeasurementSettings (0.88.0)
Version latestkeyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILE_DOWNLOADS_ENABLED_FIELD_NUMBER
public static final int FILE_DOWNLOADS_ENABLED_FIELD_NUMBER
Field Value
Type Description
int
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
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static EnhancedMeasurementSettings . Builder newBuilder ()
newBuilder(EnhancedMeasurementSettings prototype)
public static EnhancedMeasurementSettings . Builder newBuilder ( EnhancedMeasurementSettings prototype )
public static EnhancedMeasurementSettings parseDelimitedFrom ( InputStream input )
public static EnhancedMeasurementSettings parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static EnhancedMeasurementSettings parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EnhancedMeasurementSettings parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static EnhancedMeasurementSettings parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EnhancedMeasurementSettings parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static EnhancedMeasurementSettings parseFrom ( CodedInputStream input )
public static EnhancedMeasurementSettings parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static EnhancedMeasurementSettings parseFrom ( InputStream input )
public static EnhancedMeasurementSettings parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static EnhancedMeasurementSettings parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EnhancedMeasurementSettings parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<EnhancedMeasurementSettings> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public EnhancedMeasurementSettings getDefaultInstanceForType ()
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.
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()
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 ()
Overrides
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
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()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public EnhancedMeasurementSettings . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EnhancedMeasurementSettings . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public EnhancedMeasurementSettings . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
