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



2976
2977
2978
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2976

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

Instance Attribute Details

#dimensions ⇒ String

List of analytics dimensions. Corresponds to the JSON property dimensions

Returns:

  • (String) 


2924
2925
2926
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2924

def dimensions
  @dimensions
end

#end_date ⇒ String

End date. Corresponds to the JSON property end-date

Returns:

  • (String) 


2929
2930
2931
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2929

def end_date
  @end_date
end

#filters ⇒ String

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

Returns:

  • (String) 


2934
2935
2936
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2934

def filters
  @filters
end

#ids ⇒ String

Unique table ID. Corresponds to the JSON property ids

Returns:

  • (String) 


2939
2940
2941
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2939

def ids
  @ids
end

#max_results ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2944
2945
2946
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2944

def max_results
  @max_results
end

#metrics ⇒ Array<String>

List of analytics metrics. Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


2949
2950
2951
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2949

def metrics
  @metrics
end

#sampling_level ⇒ String

Desired sampling level Corresponds to the JSON property samplingLevel

Returns:

  • (String) 


2954
2955
2956
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2954

def sampling_level
  @sampling_level
end

#segment ⇒ String

Analytics advanced segment. Corresponds to the JSON property segment

Returns:

  • (String) 


2959
2960
2961
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2959

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


2964
2965
2966
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2964

def sort
  @sort
end

#start_date ⇒ String

Start date. Corresponds to the JSON property start-date

Returns:

  • (String) 


2969
2970
2971
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2969

def start_date
  @start_date
end

#start_index ⇒ Fixnum

Start index. Corresponds to the JSON property start-index

Returns:

  • (Fixnum) 


2974
2975
2976
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2974

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 2981

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