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

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

Constructor Details

#initialize(**args) ⇒ GaData

Returns a new instance of GaData.



2594
2595
2596
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2594

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:



2504
2505
2506
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2504

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) 


2509
2510
2511
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2509

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) 


2515
2516
2517
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2515

def data_last_refreshed
  @data_last_refreshed
end

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

Corresponds to the JSON property dataTable

Returns:



2520
2521
2522
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2520

def data_table
  @data_table
end

#id ⇒ String

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

Returns:

  • (String) 


2525
2526
2527
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2525

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) 


2532
2533
2534
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2532

def items_per_page
  @items_per_page
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


2537
2538
2539
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2537

def kind
  @kind
end

#next_link ⇒ String

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

Returns:

  • (String) 


2542
2543
2544
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2542

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) 


2547
2548
2549
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2547

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:



2552
2553
2554
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2552

def profile_info
  @profile_info
end

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

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

Returns:



2557
2558
2559
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2557

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


2564
2565
2566
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2564

def rows
  @rows
end

#sample_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2569
2570
2571
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2569

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) 


2574
2575
2576
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2574

def sample_space
  @sample_space
end

#self_link ⇒ String

Link to this page. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2579
2580
2581
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2579

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) 


2585
2586
2587
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2585

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


2592
2593
2594
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2592

def totals_for_all_results
  @totals_for_all_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
 
# File 'lib/google/apis/analytics_v3/classes.rb', line 2599

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