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.



2758
2759
2760
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2758

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

Instance Attribute Details

#dimensions ⇒ String

List of analytics dimensions. Corresponds to the JSON property dimensions

Returns:

  • (String) 


2706
2707
2708
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2706

def dimensions
  @dimensions
end

#end_date ⇒ String

End date. Corresponds to the JSON property end-date

Returns:

  • (String) 


2711
2712
2713
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2711

def end_date
  @end_date
end

#filters ⇒ String

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

Returns:

  • (String) 


2716
2717
2718
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2716

def filters
  @filters
end

#ids ⇒ String

Unique table ID. Corresponds to the JSON property ids

Returns:

  • (String) 


2721
2722
2723
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2721

def ids
  @ids
end

#max_results ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2726
2727
2728
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2726

def max_results
  @max_results
end

#metrics ⇒ Array<String>

List of analytics metrics. Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


2731
2732
2733
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2731

def metrics
  @metrics
end

#sampling_level ⇒ String

Desired sampling level Corresponds to the JSON property samplingLevel

Returns:

  • (String) 


2736
2737
2738
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2736

def sampling_level
  @sampling_level
end

#segment ⇒ String

Analytics advanced segment. Corresponds to the JSON property segment

Returns:

  • (String) 


2741
2742
2743
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2741

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


2746
2747
2748
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2746

def sort
  @sort
end

#start_date ⇒ String

Start date. Corresponds to the JSON property start-date

Returns:

  • (String) 


2751
2752
2753
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2751

def start_date
  @start_date
end

#start_index ⇒ Fixnum

Start index. Corresponds to the JSON property start-index

Returns:

  • (Fixnum) 


2756
2757
2758
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2756

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2763

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