このページは Cloud Translation API によって翻訳されました。

Method: properties.runRealtimeReport

HTTP リクエスト
パスパラメータ
リクエストの本文
- JSON 表現
レスポンスの本文
- JSON 表現
認可スコープ
MinuteRange
- JSON 表現
試してみる

プロパティのリアルタイムイベントデータのカスタムレポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイムレポートに表示されます。リアルタイムレポートには、現在から 30 分前（Google アナリティクス 360 プロパティの場合は最大 60 分）の期間のイベントと使用状況データが表示されます。

リアルタイムリクエストの作成とレスポンスの理解のガイドについては、リアルタイムレポートの作成をご覧ください。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ

パラメータ
`property`	`string` イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。例: properties/1234

property

string

イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。

例: properties/1234

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現

JSON 表現
{ "dimensions": [ { object (`Dimension`) } ], "metrics": [ { object (`Metric`) } ], "dimensionFilter": { object (`FilterExpression`) }, "metricFilter": { object (`FilterExpression`) }, "limit": string, "metricAggregations": [ enum (`MetricAggregation`) ], "orderBys": [ { object (`OrderBy`) } ], "returnPropertyQuota": boolean, "minuteRanges": [ { object (`MinuteRange`) } ] }

{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}

フィールド
`dimensions[]`	`object (Dimension)` リクエストされ、表示されたディメンション。
`metrics[]`	`object (Metric)` リクエストされ、表示される指標。
`dimensionFilter`	`object (FilterExpression)` ディメンションのフィルタ句。このフィルタでは指標を使用できません。
`metricFilter`	`object (FilterExpression)` 指標のフィルタ句。SQL with 句と同様に、事後集計フェーズで適用されます。このフィルタではディメンションを使用できません。
`limit`	`string (int64 format)` 返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。`limit` は正数でなければなりません。また、ディメンション値の数が `limit` より少ない場合、API はリクエストされた `limit` よりも少ない行を返すことがあります。たとえば、ディメンション「`country`」に使用できる値が 300 個未満であるため、`country` のみのレポートでは、`limit` により大きな値を設定しても、取得できる行数は 300 行までです。
`metricAggregations[]`	`enum (MetricAggregation)` 指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。
`orderBys[]`	`object (OrderBy)` レスポンス内の行の順序を指定します。
`returnPropertyQuota`	`boolean` このアナリティクスプロパティのリアルタイム割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。
`minuteRanges[]`	`object (MinuteRange)` 読み取るイベントデータの分範囲。指定しない場合は、過去 30 分間の 1 分の範囲が使用されます。複数の分の範囲がリクエストされた場合、各レスポンスの行に 0 から始まる分の範囲インデックスが含まれます。2 つの分単位の期間が重複する場合、重複する分単位のイベントデータは、両方の分単位のレスポンス行に含まれます。

レスポンスの本文

リクエストに対応するレスポンスのリアルタイムレポートの表。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現

JSON 表現
{ "dimensionHeaders": [ { object (`DimensionHeader`) } ], "metricHeaders": [ { object (`MetricHeader`) } ], "rows": [ { object (`Row`) } ], "totals": [ { object (`Row`) } ], "maximums": [ { object (`Row`) } ], "minimums": [ { object (`Row`) } ], "rowCount": integer, "propertyQuota": { object (`PropertyQuota`) }, "kind": string }

{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}

フィールド
`dimensionHeaders[]`	`object (DimensionHeader)` ディメンションの列について説明します。DimensionHeaders の数と DimensionHeaders の順序が、行に存在するディメンションと一致している。
`metricHeaders[]`	`object (MetricHeader)` 指標の列について説明します。MetricHeaders の数と MetricHeaders の順序は、行に存在する指標と一致します。
`rows[]`	`object (Row)` レポート内のディメンション値の組み合わせと指標値の行。
`totals[]`	`object (Row)` 指標の合計値（リクエストされた場合）。
`maximums[]`	`object (Row)` 指標の最大値（リクエストされた場合）。
`minimums[]`	`object (Row)` リクエストされた場合、指標の最小値。
`rowCount`	`integer` クエリ結果の行の合計数。`rowCount` は、レスポンスで返される行数と `limit` リクエストパラメータに依存しません。たとえば、クエリが 175 行を返し、API リクエストに 50 の `limit` が含まれている場合、レスポンスの `rowCount` は 175 ですが、50 行しか含まれません。
`propertyQuota`	`object (PropertyQuota)` このリクエストを含む、このアナリティクスプロパティのリアルタイム割り当ての状態。
`kind`	`string` このメッセージのリソースの種類を識別します。この `kind` は常に固定文字列「analyticsData#runRealtimeReport」です。JSON でレスポンスタイプを区別するのに役立ちます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics

MinuteRange

連続する分セット: startMinutesAgo、startMinutesAgo + 1、...、endMinutesAgo。リクエストの範囲は最大 2 分です。

JSON 表現
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer }

フィールド

フィールド
`name`	`string` この分の範囲に名前を割り当てます。レポートレスポンスでは、ディメンション `dateRange` にこの名前が設定されます。設定した場合、`date_range_` または `RESERVED_` で始めることはできません。設定しない場合、分の範囲はリクエスト内のゼロベースのインデックス（`date_range_0`、`date_range_1` など）によって名前が付けられます。
`startMinutesAgo`	`integer` クエリの開始時間を、今何分前かで指定します。たとえば、`"startMinutesAgo": 29` は 29 分前と後のイベントデータをレポートに含めることを指定します。`endMinutesAgo` より後の日付は指定できません。指定しない場合、`startMinutesAgo` はデフォルトで 29 に設定されます。標準のアナリティクスプロパティでは過去 30 分間のイベントデータ（`startMinutesAgo <= 29`）をリクエストでき、360 アナリティクスのプロパティでは過去 60 分間のイベントデータ（`startMinutesAgo <= 59`）をリクエストできます。
`endMinutesAgo`	`integer` クエリの終了分を含む時間（分前）。`startMinutesAgo` より前の日付を指定することはできません。たとえば、`"endMinutesAgo": 15` は、15 分前のイベントデータをレポートに含めることを指定します。指定しない場合、`endMinutesAgo` はデフォルトで 0 に設定されます。標準のアナリティクスプロパティでは、過去 30 分間のイベントデータ（`endMinutesAgo <= 29`）の任意の 1 分間をリクエストできます。360 のアナリティクスプロパティでは、過去 60 分間のイベントデータ（`endMinutesAgo <= 59`）の任意の 1 分間をリクエストできます。

name

string

この分の範囲に名前を割り当てます。レポートレスポンスでは、ディメンション dateRange にこの名前が設定されます。設定した場合、date_range_ または RESERVED_ で始めることはできません。設定しない場合、分の範囲はリクエスト内のゼロベースのインデックス（date_range_0、date_range_1 など）によって名前が付けられます。

startMinutesAgo

integer

クエリの開始時間を、今何分前かで指定します。たとえば、"startMinutesAgo": 29 は 29 分前と後のイベントデータをレポートに含めることを指定します。endMinutesAgo より後の日付は指定できません。

指定しない場合、startMinutesAgo はデフォルトで 29 に設定されます。標準のアナリティクスプロパティでは過去 30 分間のイベントデータ（startMinutesAgo <= 29）をリクエストでき、360 アナリティクスのプロパティでは過去 60 分間のイベントデータ（startMinutesAgo <= 59）をリクエストできます。

endMinutesAgo

integer

クエリの終了分を含む時間（分前）。startMinutesAgo より前の日付を指定することはできません。たとえば、"endMinutesAgo": 15 は、15 分前のイベントデータをレポートに含めることを指定します。

指定しない場合、endMinutesAgo はデフォルトで 0 に設定されます。標準のアナリティクスプロパティでは、過去 30 分間のイベントデータ（endMinutesAgo <= 29）の任意の 1 分間をリクエストできます。360 のアナリティクスプロパティでは、過去 60 分間のイベントデータ（endMinutesAgo <= 59）の任意の 1 分間をリクエストできます。