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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsadmin_v1alpha/classes.rb,
generated/google/apis/analyticsadmin_v1alpha/representations.rb,
generated/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.



639
640
641
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 639

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

Instance Attribute Details

#articles_and_blogs_enabled ⇒ Boolean Also known as: articles_and_blogs_enabled?

Capture events when your visitors view content on your site that has articles or blog posts. Corresponds to the JSON property articlesAndBlogsEnabled

Returns:

  • (Boolean) 


522
523
524
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 522

def articles_and_blogs_enabled
  @articles_and_blogs_enabled
end

#content_views_enabled ⇒ Boolean Also known as: content_views_enabled?

Capture events when your visitors view content on your site that has structured data (eg, articles, blog posts, product details screens, etc.). Corresponds to the JSON property contentViewsEnabled

Returns:

  • (Boolean) 


529
530
531
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 529

def content_views_enabled
  @content_views_enabled
end

#data_tagged_element_clicks_enabled ⇒ Boolean Also known as: data_tagged_element_clicks_enabled?

If enabled, capture a click event each time a visitor clicks a link or element that has data attributes beginning with "data-ga". Corresponds to the JSON property dataTaggedElementClicksEnabled

Returns:

  • (Boolean) 


536
537
538
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 536

def data_tagged_element_clicks_enabled
  @data_tagged_element_clicks_enabled
end

#excluded_domains ⇒ String

Domains to exclude from measurement. Max length is 1024 characters. Corresponds to the JSON property excludedDomains

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 542

def excluded_domains
  @excluded_domains
end

#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) 


548
549
550
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 548

def file_downloads_enabled
  @file_downloads_enabled
end

#form_interactions_enabled ⇒ Boolean Also known as: form_interactions_enabled?

If enabled, capture a view search results event each time a visitor interacts with a form on your site. Corresponds to the JSON property formInteractionsEnabled

Returns:

  • (Boolean) 


555
556
557
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 555

def form_interactions_enabled
  @form_interactions_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) 


563
564
565
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 563

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) 


569
570
571
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 569

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) 


576
577
578
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 576

def page_changes_enabled
  @page_changes_enabled
end

#page_loads_enabled ⇒ Boolean Also known as: page_loads_enabled?

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

Returns:

  • (Boolean) 


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

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) 


589
590
591
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 589

def page_views_enabled
  @page_views_enabled
end

#products_and_ecommerce_enabled ⇒ Boolean Also known as: products_and_ecommerce_enabled?

Capture events when your visitors view content on your site that has product details screens, etc. Corresponds to the JSON property productsAndEcommerceEnabled

Returns:

  • (Boolean) 


596
597
598
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 596

def products_and_ecommerce_enabled
  @products_and_ecommerce_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) 


603
604
605
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 603

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) 


610
611
612
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 610

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) 


616
617
618
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 616

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) 


624
625
626
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 624

def stream_enabled
  @stream_enabled
end

#url_query_parameter ⇒ String

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

Returns:

  • (String) 


630
631
632
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 630

def url_query_parameter
  @url_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) 


636
637
638
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 636

def video_engagement_enabled
  @video_engagement_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'generated/google/apis/analyticsadmin_v1alpha/classes.rb', line 644

def update!(**args)
  @articles_and_blogs_enabled = args[:articles_and_blogs_enabled] if args.key?(:articles_and_blogs_enabled)
  @content_views_enabled = args[:content_views_enabled] if args.key?(:content_views_enabled)
  @data_tagged_element_clicks_enabled = args[:data_tagged_element_clicks_enabled] if args.key?(:data_tagged_element_clicks_enabled)
  @excluded_domains = args[:excluded_domains] if args.key?(:excluded_domains)
  @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)
  @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)
  @products_and_ecommerce_enabled = args[:products_and_ecommerce_enabled] if args.key?(:products_and_ecommerce_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)
  @url_query_parameter = args[:url_query_parameter] if args.key?(:url_query_parameter)
  @video_engagement_enabled = args[:video_engagement_enabled] if args.key?(:video_engagement_enabled)
end