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


3572
3573
3574
# File 'generated/google/apis/analytics_v3/classes.rb', line 3572

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

Instance Attribute Details

#dimensionsString

List of analytics dimensions. Corresponds to the JSON property dimensions

Returns:

  • (String)

3520
3521
3522
# File 'generated/google/apis/analytics_v3/classes.rb', line 3520

def dimensions
  @dimensions
end

#end_dateString

End date. Corresponds to the JSON property end-date

Returns:

  • (String)

3525
3526
3527
# File 'generated/google/apis/analytics_v3/classes.rb', line 3525

def end_date
  @end_date
end

#filtersString

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

Returns:

  • (String)

3530
3531
3532
# File 'generated/google/apis/analytics_v3/classes.rb', line 3530

def filters
  @filters
end

#idsString

Unique table ID. Corresponds to the JSON property ids

Returns:

  • (String)

3535
3536
3537
# File 'generated/google/apis/analytics_v3/classes.rb', line 3535

def ids
  @ids
end

#max_resultsFixnum

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

Returns:

  • (Fixnum)

3540
3541
3542
# File 'generated/google/apis/analytics_v3/classes.rb', line 3540

def max_results
  @max_results
end

#metricsArray<String>

List of analytics metrics. Corresponds to the JSON property metrics

Returns:

  • (Array<String>)

3545
3546
3547
# File 'generated/google/apis/analytics_v3/classes.rb', line 3545

def metrics
  @metrics
end

#sampling_levelString

Desired sampling level Corresponds to the JSON property samplingLevel

Returns:

  • (String)

3550
3551
3552
# File 'generated/google/apis/analytics_v3/classes.rb', line 3550

def sampling_level
  @sampling_level
end

#segmentString

Analytics advanced segment. Corresponds to the JSON property segment

Returns:

  • (String)

3555
3556
3557
# File 'generated/google/apis/analytics_v3/classes.rb', line 3555

def segment
  @segment
end

#sortArray<String>

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

Returns:

  • (Array<String>)

3560
3561
3562
# File 'generated/google/apis/analytics_v3/classes.rb', line 3560

def sort
  @sort
end

#start_dateString

Start date. Corresponds to the JSON property start-date

Returns:

  • (String)

3565
3566
3567
# File 'generated/google/apis/analytics_v3/classes.rb', line 3565

def start_date
  @start_date
end

#start_indexFixnum

Start index. Corresponds to the JSON property start-index

Returns:

  • (Fixnum)

3570
3571
3572
# File 'generated/google/apis/analytics_v3/classes.rb', line 3570

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
# File 'generated/google/apis/analytics_v3/classes.rb', line 3577

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