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.



1177
1178
1179
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1177

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) 


1100
1101
1102
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1100

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) 


1108
1109
1110
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1108

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) 


1114
1115
1116
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1114

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) 


1121
1122
1123
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1121

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) 


1127
1128
1129
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1127

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) 


1134
1135
1136
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1134

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) 


1141
1142
1143
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1141

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) 


1148
1149
1150
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1148

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) 


1154
1155
1156
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1154

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) 


1162
1163
1164
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1162

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) 


1168
1169
1170
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1168

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) 


1174
1175
1176
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1174

def video_engagement_enabled
  @video_engagement_enabled
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1182

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