Class: Google::Apis::AnalyticsV3::GaData::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

Analytics 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



2854
2855
2856
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2854

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

Instance Attribute Details

#dimensions ⇒ String

List of analytics dimensions. Corresponds to the JSON property dimensions

Returns:

  • (String) 


2802
2803
2804
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2802

def dimensions
  @dimensions
end

#end_date ⇒ String

End date. Corresponds to the JSON property end-date

Returns:

  • (String) 


2807
2808
2809
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2807

def end_date
  @end_date
end

#filters ⇒ String

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

Returns:

  • (String) 


2812
2813
2814
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2812

def filters
  @filters
end

#ids ⇒ String

Unique table ID. Corresponds to the JSON property ids

Returns:

  • (String) 


2817
2818
2819
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2817

def ids
  @ids
end

#max_results ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2822
2823
2824
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2822

def max_results
  @max_results
end

#metrics ⇒ Array<String>

List of analytics metrics. Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


2827
2828
2829
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2827

def metrics
  @metrics
end

#sampling_level ⇒ String

Desired sampling level Corresponds to the JSON property samplingLevel

Returns:

  • (String) 


2832
2833
2834
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2832

def sampling_level
  @sampling_level
end

#segment ⇒ String

Analytics advanced segment. Corresponds to the JSON property segment

Returns:

  • (String) 


2837
2838
2839
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2837

def segment
  @segment
end

#sort ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2842
2843
2844
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2842

def sort
  @sort
end

#start_date ⇒ String

Start date. Corresponds to the JSON property start-date

Returns:

  • (String) 


2847
2848
2849
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2847

def start_date
  @start_date
end

#start_index ⇒ Fixnum

Start index. Corresponds to the JSON property start-index

Returns:

  • (Fixnum) 


2852
2853
2854
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2852

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2859

def update!(**args)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @end_date = args[:end_date] if args.key?(:end_date)
  @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)
  @sampling_level = args[:sampling_level] if args.key?(:sampling_level)
  @segment = args[:segment] if args.key?(:segment)
  @sort = args[:sort] if args.key?(:sort)
  @start_date = args[:start_date] if args.key?(:start_date)
  @start_index = args[:start_index] if args.key?(:start_index)
end