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.



3128
3129
3130
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3128

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) 


3057
3058
3059
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3057

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) 


3064
3065
3066
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3064

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) 


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

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) 


3078
3079
3080
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3078

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) 


3085
3086
3087
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3085

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) 


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

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) 


3099
3100
3101
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3099

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) 


3105
3106
3107
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3105

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) 


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

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) 


3119
3120
3121
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3119

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) 


3125
3126
3127
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3125

def video_engagement_enabled
  @video_engagement_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3133

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