Class: Google::Apis::AnalyticsV3::GaData

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

Analytics data for a given view (profile).

Defined Under Namespace

Classes: ColumnHeader, DataTable, ProfileInfo, Query

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) ⇒ GaData

Returns a new instance of GaData



2716
2717
2718
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2716

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

Instance Attribute Details

#column_headers ⇒ Array<Google::Apis::AnalyticsV3::GaData::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:



2626
2627
2628
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2626

def column_headers
  @column_headers
end

#contains_sampled_data ⇒ Boolean Also known as: contains_sampled_data?

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

Returns:

  • (Boolean) 


2631
2632
2633
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2631

def contains_sampled_data
  @contains_sampled_data
end

#data_last_refreshed ⇒ Fixnum

The last refreshed time in seconds for Analytics data. Corresponds to the JSON property dataLastRefreshed

Returns:

  • (Fixnum) 


2637
2638
2639
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2637

def data_last_refreshed
  @data_last_refreshed
end

#data_table ⇒ Google::Apis::AnalyticsV3::GaData::DataTable

Corresponds to the JSON property dataTable

Returns:



2642
2643
2644
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2642

def data_table
  @data_table
end

#id ⇒ String

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

Returns:

  • (String) 


2647
2648
2649
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2647

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) 


2654
2655
2656
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2654

def items_per_page
  @items_per_page
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


2659
2660
2661
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2659

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


2664
2665
2666
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2664

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) 


2669
2670
2671
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2669

def previous_link
  @previous_link
end

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

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

Returns:



2674
2675
2676
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2674

def profile_info
  @profile_info
end

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

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

Returns:



2679
2680
2681
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2679

def query
  @query
end

#rows ⇒ Array<Array<String>>

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:

  • (Array<Array<String>>) 


2686
2687
2688
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2686

def rows
  @rows
end

#sample_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2691
2692
2693
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2691

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) 


2696
2697
2698
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2696

def sample_space
  @sample_space
end

#self_link ⇒ String

Link to this page. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2701
2702
2703
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2701

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) 


2707
2708
2709
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2707

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


2714
2715
2716
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2714

def totals_for_all_results
  @totals_for_all_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2721

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)
  @data_last_refreshed = args[:data_last_refreshed] if args.key?(:data_last_refreshed)
  @data_table = args[:data_table] if args.key?(:data_table)
  @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