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 WebDataStream, 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.



597
598
599
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 597

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) 


520
521
522
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 520

def file_downloads_enabled
  @file_downloads_enabled
end

#name ⇒ String

Output only. Resource name of this Data Stream. Format: properties/ property_id/webDataStreams/stream_id/enhancedMeasurementSettings Example: " properties/1000/webDataStreams/2000/enhancedMeasurementSettings" Corresponds to the JSON property name

Returns:

  • (String) 


528
529
530
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 528

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) 


534
535
536
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 534

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) 


541
542
543
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 541

def page_changes_enabled
  @page_changes_enabled
end

#page_loads_enabled ⇒ Boolean Also known as: page_loads_enabled?

Output only. If enabled, capture a page view event each time a page loads. Corresponds to the JSON property pageLoadsEnabled

Returns:

  • (Boolean) 


547
548
549
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 547

def page_loads_enabled
  @page_loads_enabled
end

#page_views_enabled ⇒ Boolean Also known as: page_views_enabled?

Output only. If enabled, capture a page view event each time a page loads or the website changes the browser history state. Corresponds to the JSON property pageViewsEnabled

Returns:

  • (Boolean) 


554
555
556
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 554

def page_views_enabled
  @page_views_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) 


561
562
563
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 561

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) 


568
569
570
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 568

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) 


574
575
576
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 574

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) 


582
583
584
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 582

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) 


588
589
590
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 588

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) 


594
595
596
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 594

def video_engagement_enabled
  @video_engagement_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 602

def update!(**args)
  @file_downloads_enabled = args[:file_downloads_enabled] if args.key?(:file_downloads_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)
  @page_loads_enabled = args[:page_loads_enabled] if args.key?(:page_loads_enabled)
  @page_views_enabled = args[:page_views_enabled] if args.key?(:page_views_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