Class: Google::Analytics::Admin::V1alpha::AccessOrderBy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/admin/v1alpha/access_report.rb

Overview

Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.

Defined Under Namespace

Classes: DimensionOrderBy, MetricOrderBy

Instance Attribute Summary collapse

Instance Attribute Details

#desc ⇒ ::Boolean

Returns If true, sorts by descending order. If false or unspecified, sorts in ascending order.

Returns:

  • (::Boolean) —

    If true, sorts by descending order. If false or unspecified, sorts in ascending order.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'proto_docs/google/analytics/admin/v1alpha/access_report.rb', line 266

class AccessOrderBy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Sorts by metric values.
  # @!attribute [rw] metric_name
  #   @return [::String]
  #     A metric name in the request to order by.
  class MetricOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sorts by dimension values.
  # @!attribute [rw] dimension_name
  #   @return [::String]
  #     A dimension name in the request to order by.
  # @!attribute [rw] order_type
  #   @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy::OrderType]
  #     Controls the rule for dimension value ordering.
  class DimensionOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rule to order the string dimension values by.
    module OrderType
      # Unspecified.
      ORDER_TYPE_UNSPECIFIED = 0

      # Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
      # "b" < "z".
      ALPHANUMERIC = 1

      # Case insensitive alphanumeric sort by lower case Unicode code point.
      # For example, "2" < "A" < "b" < "X" < "z".
      CASE_INSENSITIVE_ALPHANUMERIC = 2

      # Dimension values are converted to numbers before sorting. For example
      # in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
      # "25". Non-numeric dimension values all have equal ordering value below
      # all numeric values.
      NUMERIC = 3
    end
  end
end

#dimension ⇒ ::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy

Returns Sorts results by a dimension's values.

Note: The following fields are mutually exclusive: dimension, metric. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'proto_docs/google/analytics/admin/v1alpha/access_report.rb', line 266

class AccessOrderBy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Sorts by metric values.
  # @!attribute [rw] metric_name
  #   @return [::String]
  #     A metric name in the request to order by.
  class MetricOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sorts by dimension values.
  # @!attribute [rw] dimension_name
  #   @return [::String]
  #     A dimension name in the request to order by.
  # @!attribute [rw] order_type
  #   @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy::OrderType]
  #     Controls the rule for dimension value ordering.
  class DimensionOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rule to order the string dimension values by.
    module OrderType
      # Unspecified.
      ORDER_TYPE_UNSPECIFIED = 0

      # Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
      # "b" < "z".
      ALPHANUMERIC = 1

      # Case insensitive alphanumeric sort by lower case Unicode code point.
      # For example, "2" < "A" < "b" < "X" < "z".
      CASE_INSENSITIVE_ALPHANUMERIC = 2

      # Dimension values are converted to numbers before sorting. For example
      # in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
      # "25". Non-numeric dimension values all have equal ordering value below
      # all numeric values.
      NUMERIC = 3
    end
  end
end

#metric ⇒ ::Google::Analytics::Admin::V1alpha::AccessOrderBy::MetricOrderBy

Returns Sorts results by a metric's values.

Note: The following fields are mutually exclusive: metric, dimension. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'proto_docs/google/analytics/admin/v1alpha/access_report.rb', line 266

class AccessOrderBy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Sorts by metric values.
  # @!attribute [rw] metric_name
  #   @return [::String]
  #     A metric name in the request to order by.
  class MetricOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sorts by dimension values.
  # @!attribute [rw] dimension_name
  #   @return [::String]
  #     A dimension name in the request to order by.
  # @!attribute [rw] order_type
  #   @return [::Google::Analytics::Admin::V1alpha::AccessOrderBy::DimensionOrderBy::OrderType]
  #     Controls the rule for dimension value ordering.
  class DimensionOrderBy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Rule to order the string dimension values by.
    module OrderType
      # Unspecified.
      ORDER_TYPE_UNSPECIFIED = 0

      # Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
      # "b" < "z".
      ALPHANUMERIC = 1

      # Case insensitive alphanumeric sort by lower case Unicode code point.
      # For example, "2" < "A" < "b" < "X" < "z".
      CASE_INSENSITIVE_ALPHANUMERIC = 2

      # Dimension values are converted to numbers before sorting. For example
      # in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
      # "25". Non-numeric dimension values all have equal ordering value below
      # all numeric values.
      NUMERIC = 3
    end
  end
end