Package com.google.analytics.admin.v1alpha

Class EnhancedMeasurementSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.EnhancedMeasurementSettings
All Implemented Interfaces:
EnhancedMeasurementSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class EnhancedMeasurementSettings extends com.google.protobuf.GeneratedMessage implements EnhancedMeasurementSettingsOrBuilder
 Singleton resource under a web DataStream, configuring measurement of
 additional site interactions and content.
Protobuf type google.analytics.admin.v1alpha.EnhancedMeasurementSettings
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • STREAM_ENABLED_FIELD_NUMBER

      public static final int STREAM_ENABLED_FIELD_NUMBER
      See Also:

    • SCROLLS_ENABLED_FIELD_NUMBER

      public static final int SCROLLS_ENABLED_FIELD_NUMBER
      See Also:

    • OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER

      public static final int OUTBOUND_CLICKS_ENABLED_FIELD_NUMBER
      See Also:

    • SITE_SEARCH_ENABLED_FIELD_NUMBER

      public static final int SITE_SEARCH_ENABLED_FIELD_NUMBER
      See Also:

    • VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER

      public static final int VIDEO_ENGAGEMENT_ENABLED_FIELD_NUMBER
      See Also:

    • FILE_DOWNLOADS_ENABLED_FIELD_NUMBER

      public static final int FILE_DOWNLOADS_ENABLED_FIELD_NUMBER
      See Also:

    • PAGE_CHANGES_ENABLED_FIELD_NUMBER

      public static final int PAGE_CHANGES_ENABLED_FIELD_NUMBER
      See Also:

    • FORM_INTERACTIONS_ENABLED_FIELD_NUMBER

      public static final int FORM_INTERACTIONS_ENABLED_FIELD_NUMBER
      See Also:

    • SEARCH_QUERY_PARAMETER_FIELD_NUMBER

      public static final int SEARCH_QUERY_PARAMETER_FIELD_NUMBER
      See Also:

    • URI_QUERY_PARAMETER_FIELD_NUMBER

      public static final int URI_QUERY_PARAMETER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      getStreamEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The streamEnabled.

    • getScrollsEnabled

      public boolean getScrollsEnabled()
       If enabled, capture scroll events each time a visitor gets to the bottom of
 a page.
      bool scrolls_enabled = 3;
      Specified by:
      getScrollsEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The scrollsEnabled.

    • 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;
      Specified by:
      getOutboundClicksEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The outboundClicksEnabled.

    • 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;
      Specified by:
      getSiteSearchEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The siteSearchEnabled.

    • 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;
      Specified by:
      getVideoEngagementEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The videoEngagementEnabled.

    • 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;
      Specified by:
      getFileDownloadsEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The fileDownloadsEnabled.

    • 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;
      Specified by:
      getPageChangesEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The pageChangesEnabled.

    • 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;
      Specified by:
      getFormInteractionsEnabled in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The formInteractionsEnabled.

    • 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];
      Specified by:
      getSearchQueryParameter in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The searchQueryParameter.

    • getSearchQueryParameterBytes

      public com.google.protobuf.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];
      Specified by:
      getSearchQueryParameterBytes in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The bytes for searchQueryParameter.

    • getUriQueryParameter

      public String getUriQueryParameter()
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Specified by:
      getUriQueryParameter in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The uriQueryParameter.

    • getUriQueryParameterBytes

      public com.google.protobuf.ByteString getUriQueryParameterBytes()
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Specified by:
      getUriQueryParameterBytes in interface EnhancedMeasurementSettingsOrBuilder
      Returns:
      The bytes for uriQueryParameter.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static EnhancedMeasurementSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static EnhancedMeasurementSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public EnhancedMeasurementSettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static EnhancedMeasurementSettings.Builder newBuilder()

    • newBuilder

      public static EnhancedMeasurementSettings.Builder newBuilder(EnhancedMeasurementSettings prototype)

    • toBuilder

      public EnhancedMeasurementSettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected EnhancedMeasurementSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EnhancedMeasurementSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<EnhancedMeasurementSettings> parser()

    • getParserForType

      public com.google.protobuf.Parser<EnhancedMeasurementSettings> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public EnhancedMeasurementSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder