OrderBy

Order by は、レスポンスで行を並べ替える方法を定義します。たとえば、イベント数の降順で行を並べ替えるのは 1 つの順序付けであり、イベント名の文字列で行を並べ替えるのは別の順序付けです。

JSON 表現
{
  "desc": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  },
  "pivot": {
    object (PivotOrderBy)
  }
  // End of mutually exclusive fields.
}
フィールド
desc

boolean

true の場合、降順で並べ替えます。

OrderBy の並べ替え順序を 1 つ指定します。以下は、相互に排他的なフィールドのリストです。レスポンスで設定されるフィールドは最大で 1 つです。
metric

object (MetricOrderBy)

結果を指標の値で並べ替えます。

dimension

object (DimensionOrderBy)

結果をディメンションの値で並べ替えます。

pivot

object (PivotOrderBy)

結果をピボット列グループ内の指標の値で並べ替えます。

相互に排他的なフィールドの終了。

MetricOrderBy

指標の値で並べ替えます。

JSON 表現
{
  "metricName": string
}
フィールド
metricName

string

並べ替えに使用するリクエスト内の指標名。

DimensionOrderBy

ディメンションの値で並べ替えます。

JSON 表現
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
フィールド
dimensionName

string

並べ替えの基準となるリクエスト内のディメンション名。

orderType

enum (OrderType)

ディメンション値の順序付けのルールを制御します。

OrderType

文字列ディメンションの値を並べ替えるルール。

列挙型
ORDER_TYPE_UNSPECIFIED 指定なし。
ALPHANUMERIC 英数字は Unicode コードポイントで並べ替えられます。たとえば、「2」 < 「A」 < 「X」 < 「b」 < 「z」となります。
CASE_INSENSITIVE_ALPHANUMERIC 大文字と小文字を区別しない英数字の並べ替えは、小文字の Unicode コードポイントで行われます。たとえば、「2」 < 「A」 < 「b」 < 「X」 < 「z」となります。
NUMERIC ディメンション値は、並べ替えの前に数値に変換されます。たとえば、数値の並べ替えでは「25」<「100」ですが、ALPHANUMERIC の並べ替えでは「100」<「25」になります。数値以外のディメンション値はすべて、数値以外の値よりも小さい同じ順序値になります。

PivotOrderBy

ピボット列グループで並べ替えます。

JSON 表現
{
  "metricName": string,
  "pivotSelections": [
    {
      object (PivotSelection)
    }
  ]
}
フィールド
metricName

string

並べ替えのレスポンスで、この列で並べ替えます。リクエストの指標名である必要があります。

pivotSelections[]

object (PivotSelection)

ディメンション名と値のピボットを選択するために使用されます。複数のピボット選択が指定されている場合、すべてのピボット選択ディメンション名と値のペアが、行のディメンション名と値のペアに一致する行で並べ替えが行われます。

PivotSelection

ディメンション名と値のペア。このディメンション ピボット ペアを含む行は、指標の値で並べ替えられます。

たとえば、pivots =('browser', 'Chrome')で metricName = "Sessions" の場合、行は Chrome のセッションに基づいて並べ替えられます。

---------|----------|----------------|----------|----------------
         |  Chrome  |    Chrome      |  Safari  |     Safari
---------|----------|----------------|----------|----------------
 Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions
---------|----------|----------------|----------|----------------
    US   |    2     |       2        |     3    |        1
---------|----------|----------------|----------|----------------
  Canada |    3     |       1        |     4    |        1
---------|----------|----------------|----------|----------------
JSON 表現
{
  "dimensionName": string,
  "dimensionValue": string
}
フィールド
dimensionName

string

リクエストのディメンション名を指定する必要があります。

dimensionValue

string

名前付きディメンションがこの値の場合にのみ並べ替えます。