Class: Google::Apis::AnalyticsV3::GaData
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsV3::GaData
- 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
-
#column_headers ⇒ Array<Google::Apis::AnalyticsV3::GaData::ColumnHeader>
Column headers that list dimension names followed by the metric names.
-
#contains_sampled_data ⇒ Boolean
(also: #contains_sampled_data?)
Determines if Analytics data contains samples.
-
#data_last_refreshed ⇒ Fixnum
The last refreshed time in seconds for Analytics data.
-
#data_table ⇒ Google::Apis::AnalyticsV3::GaData::DataTable
Corresponds to the JSON property
dataTable
. -
#id ⇒ String
Unique ID for this data response.
-
#items_per_page ⇒ Fixnum
The maximum number of rows the response can contain, regardless of the actual number of rows returned.
-
#kind ⇒ String
Resource type.
-
#next_link ⇒ String
Link to next page for this Analytics data query.
-
#previous_link ⇒ String
Link to previous page for this Analytics data query.
-
#profile_info ⇒ Google::Apis::AnalyticsV3::GaData::ProfileInfo
Information for the view (profile), for which the Analytics data was requested.
-
#query ⇒ Google::Apis::AnalyticsV3::GaData::Query
Analytics data request query parameters.
-
#rows ⇒ Array<Array<String>>
Analytics data rows, where each row contains a list of dimension values followed by the metric values.
-
#sample_size ⇒ Fixnum
The number of samples used to calculate the result.
-
#sample_space ⇒ Fixnum
Total size of the sample space from which the samples were selected.
-
#self_link ⇒ String
Link to this page.
-
#total_results ⇒ Fixnum
The total number of rows for the query, regardless of the number of rows in the response.
-
#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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GaData
constructor
A new instance of GaData.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GaData
Returns a new instance of GaData
2498 2499 2500 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2498 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
2408 2409 2410 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2408 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
2413 2414 2415 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2413 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
2419 2420 2421 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2419 def data_last_refreshed @data_last_refreshed end |
#data_table ⇒ Google::Apis::AnalyticsV3::GaData::DataTable
Corresponds to the JSON property dataTable
2424 2425 2426 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2424 def data_table @data_table end |
#id ⇒ String
Unique ID for this data response.
Corresponds to the JSON property id
2429 2430 2431 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2429 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
2436 2437 2438 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2436 def items_per_page @items_per_page end |
#kind ⇒ String
Resource type.
Corresponds to the JSON property kind
2441 2442 2443 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2441 def kind @kind end |
#next_link ⇒ String
Link to next page for this Analytics data query.
Corresponds to the JSON property nextLink
2446 2447 2448 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2446 def next_link @next_link end |
#previous_link ⇒ String
Link to previous page for this Analytics data query.
Corresponds to the JSON property previousLink
2451 2452 2453 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2451 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
2456 2457 2458 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2456 def profile_info @profile_info end |
#query ⇒ Google::Apis::AnalyticsV3::GaData::Query
Analytics data request query parameters.
Corresponds to the JSON property query
2461 2462 2463 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2461 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
2468 2469 2470 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2468 def rows @rows end |
#sample_size ⇒ Fixnum
The number of samples used to calculate the result.
Corresponds to the JSON property sampleSize
2473 2474 2475 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2473 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
2478 2479 2480 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2478 def sample_space @sample_space end |
#self_link ⇒ String
Link to this page.
Corresponds to the JSON property selfLink
2483 2484 2485 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2483 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
2489 2490 2491 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2489 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
2496 2497 2498 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2496 def totals_for_all_results @totals_for_all_results end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 |
# File 'generated/google/apis/analytics_v3/classes.rb', line 2503 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 |