Class: Google::Apis::AnalyticsreportingV4::OrderBy

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb

Overview

Specifies the sorting options.

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

Returns a new instance of OrderBy.


933
934
935
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 933

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

Instance Attribute Details

#field_nameString

The field which to sort by. The default sort order is ascending. Example: ga: browser. Note, that you can only specify one field for sort here. For example, ga:browser, ga:city is not valid. Corresponds to the JSON property fieldName

Returns:

  • (String)

921
922
923
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 921

def field_name
  @field_name
end

#order_typeString

The order type. The default orderType is VALUE. Corresponds to the JSON property orderType

Returns:

  • (String)

926
927
928
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 926

def order_type
  @order_type
end

#sort_orderString

The sorting order for the field. Corresponds to the JSON property sortOrder

Returns:

  • (String)

931
932
933
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 931

def sort_order
  @sort_order
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


938
939
940
941
942
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 938

def update!(**args)
  @field_name = args[:field_name] if args.key?(:field_name)
  @order_type = args[:order_type] if args.key?(:order_type)
  @sort_order = args[:sort_order] if args.key?(:sort_order)
end