Class: Google::Apis::AnalyticsV3::McfData

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

Overview

Multi-Channel Funnels data for a given view (profile).

Defined Under Namespace

Classes: ColumnHeader, ProfileInfo, Query, Row

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ McfData

Returns a new instance of McfData



3628
3629
3630
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3628

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

Instance Attribute Details

#column_headers ⇒ Array<Google::Apis::AnalyticsV3::McfData::ColumnHeader>

Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. Corresponds to the JSON property columnHeaders

Returns:



3548
3549
3550
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3548

def column_headers
  @column_headers
end

#contains_sampled_data ⇒ Boolean Also known as: contains_sampled_data?

Determines if the Analytics data contains sampled data. Corresponds to the JSON property containsSampledData

Returns:

  • (Boolean) 


3553
3554
3555
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3553

def contains_sampled_data
  @contains_sampled_data
end

#id ⇒ String

Unique ID for this data response. Corresponds to the JSON property id

Returns:

  • (String) 


3559
3560
3561
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3559

def id
  @id
end

#items_per_page ⇒ Fixnum

The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. Corresponds to the JSON property itemsPerPage

Returns:

  • (Fixnum) 


3566
3567
3568
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3566

def items_per_page
  @items_per_page
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


3571
3572
3573
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3571

def kind
  @kind
end

#next_link ⇒ String

Link to next page for this Analytics data query. Corresponds to the JSON property nextLink

Returns:

  • (String) 


3576
3577
3578
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3576

def next_link
  @next_link
end

#previous_link ⇒ String

Link to previous page for this Analytics data query. Corresponds to the JSON property previousLink

Returns:

  • (String) 


3581
3582
3583
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3581

def previous_link
  @previous_link
end

#profile_info ⇒ Google::Apis::AnalyticsV3::McfData::ProfileInfo

Information for the view (profile), for which the Analytics data was requested. Corresponds to the JSON property profileInfo

Returns:



3586
3587
3588
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3586

def profile_info
  @profile_info
end

#query ⇒ Google::Apis::AnalyticsV3::McfData::Query

Analytics data request query parameters. Corresponds to the JSON property query

Returns:



3591
3592
3593
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3591

def query
  @query
end

#rows ⇒ Array<Array<Google::Apis::AnalyticsV3::McfData::Row>>

Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. Corresponds to the JSON property rows

Returns:



3598
3599
3600
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3598

def rows
  @rows
end

#sample_size ⇒ Fixnum

The number of samples used to calculate the result. Corresponds to the JSON property sampleSize

Returns:

  • (Fixnum) 


3603
3604
3605
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3603

def sample_size
  @sample_size
end

#sample_space ⇒ Fixnum

Total size of the sample space from which the samples were selected. Corresponds to the JSON property sampleSpace

Returns:

  • (Fixnum) 


3608
3609
3610
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3608

def sample_space
  @sample_space
end

#self_link ⇒ String

Link to this page. Corresponds to the JSON property selfLink

Returns:

  • (String) 


3613
3614
3615
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3613

def self_link
  @self_link
end

#total_results ⇒ Fixnum

The total number of rows for the query, regardless of the number of rows in the response. Corresponds to the JSON property totalResults

Returns:

  • (Fixnum) 


3619
3620
3621
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3619

def total_results
  @total_results
end

#totals_for_all_results ⇒ Hash<String,String>

Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. Corresponds to the JSON property totalsForAllResults

Returns:

  • (Hash<String,String>) 


3626
3627
3628
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3626

def totals_for_all_results
  @totals_for_all_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 3633

def update!(**args)
  @column_headers = args[:column_headers] if args.key?(:column_headers)
  @contains_sampled_data = args[:contains_sampled_data] if args.key?(:contains_sampled_data)
  @id = args[:id] if args.key?(:id)
  @items_per_page = args[:items_per_page] if args.key?(:items_per_page)
  @kind = args[:kind] if args.key?(:kind)
  @next_link = args[:next_link] if args.key?(:next_link)
  @previous_link = args[:previous_link] if args.key?(:previous_link)
  @profile_info = args[:profile_info] if args.key?(:profile_info)
  @query = args[:query] if args.key?(:query)
  @rows = args[:rows] if args.key?(:rows)
  @sample_size = args[:sample_size] if args.key?(:sample_size)
  @sample_space = args[:sample_space] if args.key?(:sample_space)
  @self_link = args[:self_link] if args.key?(:self_link)
  @total_results = args[:total_results] if args.key?(:total_results)
  @totals_for_all_results = args[:totals_for_all_results] if args.key?(:totals_for_all_results)
end