Package com.google.analytics.admin.v1alpha

Interface EnhancedMeasurementSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EnhancedMeasurementSettings, EnhancedMeasurementSettings.Builder
@Generated public interface EnhancedMeasurementSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    getFormInteractionsEnabled()
    If enabled, capture a form interaction event each time a visitor interacts with a form on your website.
    String
    getName()
    Output only.
    com.google.protobuf.ByteString
    getNameBytes()
    Output only.
    boolean
    getOutboundClicksEnabled()
    If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain.
    boolean
    getPageChangesEnabled()
    If enabled, capture a page view event each time the website changes the browser history state.
    boolean
    getScrollsEnabled()
    If enabled, capture scroll events each time a visitor gets to the bottom of a page.
    String
    getSearchQueryParameter()
    Required.
    com.google.protobuf.ByteString
    getSearchQueryParameterBytes()
    Required.
    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).
    boolean
    getStreamEnabled()
    Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream.
    String
    getUriQueryParameter()
    Additional URL query parameters.
    com.google.protobuf.ByteString
    getUriQueryParameterBytes()
    Additional URL query parameters.
    boolean
    getVideoEngagementEnabled()
    If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getStreamEnabled

      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:
      The streamEnabled.

    • getScrollsEnabled

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

    • getOutboundClicksEnabled

      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:
      The outboundClicksEnabled.

    • getSiteSearchEnabled

      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:
      The siteSearchEnabled.

    • getVideoEngagementEnabled

      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:
      The videoEngagementEnabled.

    • getFileDownloadsEnabled

      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:
      The fileDownloadsEnabled.

    • getPageChangesEnabled

      boolean getPageChangesEnabled()
       If enabled, capture a page view event each time the website changes the
 browser history state.
      bool page_changes_enabled = 8;
      Returns:
      The pageChangesEnabled.

    • getFormInteractionsEnabled

      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:
      The formInteractionsEnabled.

    • getSearchQueryParameter

      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:
      The searchQueryParameter.

    • getSearchQueryParameterBytes

      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];
      Returns:
      The bytes for searchQueryParameter.

    • getUriQueryParameter

      String getUriQueryParameter()
       Additional URL query parameters.
 Max length is 1024 characters.
      string uri_query_parameter = 11;
      Returns:
      The uriQueryParameter.

    • getUriQueryParameterBytes

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