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



3600
3601
3602
# File 'generated/google/apis/analytics_v3/classes.rb', line 3600

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

Instance Attribute Details

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



3520
3521
3522
# File 'generated/google/apis/analytics_v3/classes.rb', line 3520

def column_headers
  @column_headers
end

#contains_sampled_dataBoolean Also known as: contains_sampled_data?

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

Returns:

  • (Boolean)


3525
3526
3527
# File 'generated/google/apis/analytics_v3/classes.rb', line 3525

def contains_sampled_data
  @contains_sampled_data
end

#idString

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

Returns:

  • (String)


3531
3532
3533
# File 'generated/google/apis/analytics_v3/classes.rb', line 3531

def id
  @id
end

#items_per_pageFixnum

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)


3538
3539
3540
# File 'generated/google/apis/analytics_v3/classes.rb', line 3538

def items_per_page
  @items_per_page
end

#kindString

Resource type. Corresponds to the JSON property kind

Returns:

  • (String)


3543
3544
3545
# File 'generated/google/apis/analytics_v3/classes.rb', line 3543

def kind
  @kind
end

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

Returns:

  • (String)


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

def next_link
  @next_link
end

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

Returns:

  • (String)


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

def previous_link
  @previous_link
end

#profile_infoGoogle::Apis::AnalyticsV3::McfData::ProfileInfo

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



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

def profile_info
  @profile_info
end

#queryGoogle::Apis::AnalyticsV3::McfData::Query

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



3563
3564
3565
# File 'generated/google/apis/analytics_v3/classes.rb', line 3563

def query
  @query
end

#rowsArray<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:



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

def rows
  @rows
end

#sample_sizeFixnum

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

Returns:

  • (Fixnum)


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

def sample_size
  @sample_size
end

#sample_spaceFixnum

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

Returns:

  • (Fixnum)


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

def sample_space
  @sample_space
end

Link to this page. Corresponds to the JSON property selfLink

Returns:

  • (String)


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

def self_link
  @self_link
end

#total_resultsFixnum

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)


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

def total_results
  @total_results
end

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


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

def totals_for_all_results
  @totals_for_all_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
# File 'generated/google/apis/analytics_v3/classes.rb', line 3605

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