Class: Google::Apis::AnalyticsV3::RealtimeData

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

Real time data for a given view (profile).

Defined Under Namespace

Classes: ColumnHeader, 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) ⇒ RealtimeData

Returns a new instance of RealtimeData.



4248
4249
4250
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4248

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

Instance Attribute Details

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



4201
4202
4203
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4201

def column_headers
  @column_headers
end

#id ⇒ String

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

Returns:

  • (String) 


4206
4207
4208
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4206

def id
  @id
end

#kind ⇒ String

Resource type. Corresponds to the JSON property kind

Returns:

  • (String) 


4211
4212
4213
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4211

def kind
  @kind
end

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

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

Returns:



4216
4217
4218
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4216

def profile_info
  @profile_info
end

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

Real time data request query parameters. Corresponds to the JSON property query

Returns:



4221
4222
4223
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4221

def query
  @query
end

#rows ⇒ Array<Array<String>>

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


4228
4229
4230
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4228

def rows
  @rows
end

#self_link ⇒ String

Link to this page. Corresponds to the JSON property selfLink

Returns:

  • (String) 


4233
4234
4235
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4233

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) 


4239
4240
4241
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4239

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


4246
4247
4248
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4246

def totals_for_all_results
  @totals_for_all_results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 4253

def update!(**args)
  @column_headers = args[:column_headers] if args.key?(:column_headers)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @profile_info = args[:profile_info] if args.key?(:profile_info)
  @query = args[:query] if args.key?(:query)
  @rows = args[:rows] if args.key?(:rows)
  @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