Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb

Overview

Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings

Returns a new instance of GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings.



3116
3117
3118
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3116

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#file_downloads_enabled ⇒ Boolean Also known as: file_downloads_enabled?

If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension. Corresponds to the JSON property fileDownloadsEnabled

Returns:

  • (Boolean) 


3045
3046
3047
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3045

def file_downloads_enabled
  @file_downloads_enabled
end

#form_interactions_enabled ⇒ Boolean Also known as: form_interactions_enabled?

If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. Corresponds to the JSON property formInteractionsEnabled

Returns:

  • (Boolean) 


3052
3053
3054
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3052

def form_interactions_enabled
  @form_interactions_enabled
end

#name ⇒ String

Output only. Resource name of the Enhanced Measurement Settings. Format: properties/property_id/dataStreams/data_stream/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" Corresponds to the JSON property name

Returns:

  • (String) 


3060
3061
3062
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3060

def name
  @name
end

#outbound_clicks_enabled ⇒ Boolean Also known as: outbound_clicks_enabled?

If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. Corresponds to the JSON property outboundClicksEnabled

Returns:

  • (Boolean) 


3066
3067
3068
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3066

def outbound_clicks_enabled
  @outbound_clicks_enabled
end

#page_changes_enabled ⇒ Boolean Also known as: page_changes_enabled?

If enabled, capture a page view event each time the website changes the browser history state. Corresponds to the JSON property pageChangesEnabled

Returns:

  • (Boolean) 


3073
3074
3075
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3073

def page_changes_enabled
  @page_changes_enabled
end

#scrolls_enabled ⇒ Boolean Also known as: scrolls_enabled?

If enabled, capture scroll events each time a visitor gets to the bottom of a page. Corresponds to the JSON property scrollsEnabled

Returns:

  • (Boolean) 


3080
3081
3082
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3080

def scrolls_enabled
  @scrolls_enabled
end

#search_query_parameter ⇒ String

Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. Corresponds to the JSON property searchQueryParameter

Returns:

  • (String) 


3087
3088
3089
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3087

def search_query_parameter
  @search_query_parameter
end

#site_search_enabled ⇒ Boolean Also known as: site_search_enabled?

If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter). Corresponds to the JSON property siteSearchEnabled

Returns:

  • (Boolean) 


3093
3094
3095
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3093

def site_search_enabled
  @site_search_enabled
end

#stream_enabled ⇒ Boolean Also known as: stream_enabled?

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. Corresponds to the JSON property streamEnabled

Returns:

  • (Boolean) 


3101
3102
3103
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3101

def stream_enabled
  @stream_enabled
end

#uri_query_parameter ⇒ String

Additional URL query parameters. Max length is 1024 characters. Corresponds to the JSON property uriQueryParameter

Returns:

  • (String) 


3107
3108
3109
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3107

def uri_query_parameter
  @uri_query_parameter
end

#video_engagement_enabled ⇒ Boolean Also known as: video_engagement_enabled?

If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. Corresponds to the JSON property videoEngagementEnabled

Returns:

  • (Boolean) 


3113
3114
3115
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3113

def video_engagement_enabled
  @video_engagement_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3121

def update!(**args)
  @file_downloads_enabled = args[:file_downloads_enabled] if args.key?(:file_downloads_enabled)
  @form_interactions_enabled = args[:form_interactions_enabled] if args.key?(:form_interactions_enabled)
  @name = args[:name] if args.key?(:name)
  @outbound_clicks_enabled = args[:outbound_clicks_enabled] if args.key?(:outbound_clicks_enabled)
  @page_changes_enabled = args[:page_changes_enabled] if args.key?(:page_changes_enabled)
  @scrolls_enabled = args[:scrolls_enabled] if args.key?(:scrolls_enabled)
  @search_query_parameter = args[:search_query_parameter] if args.key?(:search_query_parameter)
  @site_search_enabled = args[:site_search_enabled] if args.key?(:site_search_enabled)
  @stream_enabled = args[:stream_enabled] if args.key?(:stream_enabled)
  @uri_query_parameter = args[:uri_query_parameter] if args.key?(:uri_query_parameter)
  @video_engagement_enabled = args[:video_engagement_enabled] if args.key?(:video_engagement_enabled)
end