Method: properties.runRealtimeReport

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

リアルタイム リクエストとリクエストのリアルタイム レポートの作成をご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

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)

指標のフィルタ句。SQL の has 句と同様に、集計後のフェーズで適用されます。このフィルタではディメンションを使用できません。
limit

string (int64 format)

返される行数。指定しない場合は、10,000 行が返されます。指定した行数にかかわらず、API はリクエストごとに最大 250,000 行を返します。limit は正数で指定してください。

また、ディメンション値が limit の数より少ない場合、API はリクエストされた limit よりも少ない行を返すこともあります。たとえば、ディメンション country の有効な値が 300 個未満の場合、country のみに関するレポートでは、limit により大きな値を設定しても、取得できる行は 300 行までです。
metricAggregations[]

enum (MetricAggregation)

指標の集計。集計された指標値は、dimensionValues が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。
orderBys[]

object (OrderBy)

レスポンスの行の順序を指定します。
returnPropertyQuota

boolean

このアナリティクス プロパティの Realtime Quota の現在の状態を返すかどうかを切り替えます。Quota は PropertyQuota で返されます。
minuteRanges[]

object (MinuteRange)

読み取るイベントデータの時間範囲（分単位）。指定しない場合は、過去 30 分間に 1 分間の範囲が使用されます。複数の分単位の範囲がリクエストされた場合、レスポンスの各行には、0 を基準とする分単位の範囲インデックスが含まれます。2 つの分の範囲が重複する場合、重複する時間のイベントデータが両方の分の範囲のレスポンス行に含まれます。

レスポンスの本文

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

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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)

ディメンション列について説明します。DimensionHeader の数と DimensionHeader の順序が、行内のディメンションと一致しています。
metricHeaders[]

object (MetricHeader)

指標の列について説明します。MetricHeader の数と MetricHeader の順序は、行にある指標と一致します。
rows[]

object (Row)

レポート内のディメンション値の組み合わせと指標値の行。
totals[]

object (Row)

指標の合計値（リクエストされた場合）。
maximums[]

object (Row)

リクエストされた場合、指標の最大値。
minimums[]

object (Row)

指標の最小値（リクエストされた場合）。
rowCount

integer

クエリ結果の行の合計数。rowCount は、レスポンスで返される行数や limit リクエスト パラメータに依存しません。たとえば、175 行を返すクエリが API リクエストに 50 の limit を含む場合、レスポンスには 175 の rowCount が含まれますが、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）の任意の分をリクエストでき、360 アナリティクス プロパティでは、過去 60 分間のイベントデータ（endMinutesAgo <= 59）の任意の分をリクエストできます。