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

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 request query parameters.

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

Returns a new instance of Query.


4552
4553
4554
# File 'generated/google/apis/analytics_v3/classes.rb', line 4552

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

Instance Attribute Details

#dimensionsString

List of real time dimensions. Corresponds to the JSON property dimensions

Returns:

  • (String)

4525
4526
4527
# File 'generated/google/apis/analytics_v3/classes.rb', line 4525

def dimensions
  @dimensions
end

#filtersString

Comma-separated list of dimension or metric filters. Corresponds to the JSON property filters

Returns:

  • (String)

4530
4531
4532
# File 'generated/google/apis/analytics_v3/classes.rb', line 4530

def filters
  @filters
end

#idsString

Unique table ID. Corresponds to the JSON property ids

Returns:

  • (String)

4535
4536
4537
# File 'generated/google/apis/analytics_v3/classes.rb', line 4535

def ids
  @ids
end

#max_resultsFixnum

Maximum results per page. Corresponds to the JSON property max-results

Returns:

  • (Fixnum)

4540
4541
4542
# File 'generated/google/apis/analytics_v3/classes.rb', line 4540

def max_results
  @max_results
end

#metricsArray<String>

List of real time metrics. Corresponds to the JSON property metrics

Returns:

  • (Array<String>)

4545
4546
4547
# File 'generated/google/apis/analytics_v3/classes.rb', line 4545

def metrics
  @metrics
end

#sortArray<String>

List of dimensions or metrics based on which real time data is sorted. Corresponds to the JSON property sort

Returns:

  • (Array<String>)

4550
4551
4552
# File 'generated/google/apis/analytics_v3/classes.rb', line 4550

def sort
  @sort
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4557
4558
4559
4560
4561
4562
4563
4564
# File 'generated/google/apis/analytics_v3/classes.rb', line 4557

def update!(**args)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @filters = args[:filters] if args.key?(:filters)
  @ids = args[:ids] if args.key?(:ids)
  @max_results = args[:max_results] if args.key?(:max_results)
  @metrics = args[:metrics] if args.key?(:metrics)
  @sort = args[:sort] if args.key?(:sort)
end