Package com.google.analytics.admin.v1alpha

Class EnhancedMeasurementSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<EnhancedMeasurementSettings.Builder>
com.google.analytics.admin.v1alpha.EnhancedMeasurementSettings.Builder
All Implemented Interfaces:
EnhancedMeasurementSettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
EnhancedMeasurementSettings
public static final class EnhancedMeasurementSettings.Builder extends com.google.protobuf.GeneratedMessage.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

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

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<EnhancedMeasurementSettings.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public EnhancedMeasurementSettings.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EnhancedMeasurementSettings.Builder>

    • mergeFrom

      public EnhancedMeasurementSettings.Builder mergeFrom(EnhancedMeasurementSettings other)

    • isInitialized

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

    • mergeFrom

      public EnhancedMeasurementSettings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EnhancedMeasurementSettings.Builder>
      Throws:
      IOException

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

    • setName

      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];
      Parameters:
      value - The name to set.
      Returns:
      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:
      This builder for chaining.

    • setNameBytes

      public EnhancedMeasurementSettings.Builder setNameBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

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

    • setStreamEnabled

      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;
      Parameters:
      value - The streamEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setScrollsEnabled

      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;
      Parameters:
      value - The scrollsEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setOutboundClicksEnabled

      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;
      Parameters:
      value - The outboundClicksEnabled to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setSiteSearchEnabled

      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;
      Parameters:
      value - The siteSearchEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setVideoEngagementEnabled

      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;
      Parameters:
      value - The videoEngagementEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setFileDownloadsEnabled

      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;
      Parameters:
      value - The fileDownloadsEnabled to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

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

    • setPageChangesEnabled

      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;
      Parameters:
      value - The pageChangesEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setFormInteractionsEnabled

      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;
      Parameters:
      value - The formInteractionsEnabled to set.
      Returns:
      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:
      This builder for chaining.

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

    • setSearchQueryParameter

      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];
      Parameters:
      value - The searchQueryParameter to set.
      Returns:
      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:
      This builder for chaining.

    • setSearchQueryParameterBytes

      public EnhancedMeasurementSettings.Builder setSearchQueryParameterBytes(com.google.protobuf.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];
      Parameters:
      value - The bytes for searchQueryParameter to set.
      Returns:
      This builder for chaining.

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

    • setUriQueryParameter

      public EnhancedMeasurementSettings.Builder setUriQueryParameter(String value)
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Parameters:
      value - The uriQueryParameter to set.
      Returns:
      This builder for chaining.

    • clearUriQueryParameter

      public EnhancedMeasurementSettings.Builder clearUriQueryParameter()
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Returns:
      This builder for chaining.

    • setUriQueryParameterBytes

      public EnhancedMeasurementSettings.Builder setUriQueryParameterBytes(com.google.protobuf.ByteString value)
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Parameters:
      value - The bytes for uriQueryParameter to set.
      Returns:
      This builder for chaining.