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 プロパティの識別子。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-clause と同様に、集計後のフェーズで適用されます。このフィルタではディメンションを使用できません。

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 分の範囲が使用されます。複数の分範囲がリクエストされた場合、各レスポンス行にはゼロベースの分範囲インデックスが含まれます。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)

ディメンション列について説明します。ディメンションヘッダーの数と ディメンションヘッダーの順序が、行のディメンションと一致しています。

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 が含まれている場合、レスポンスには 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

連続した時間セット: startMinutesAgostartMinutesAgo + 1、...、endMinutesAgo。リクエストの範囲は最大 2 分です。

JSON 表現
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
フィールド
name

string

この時間の範囲に名前を割り当てます。レポートのレスポンスでは、ディメンション dateRange にこの名前が付けられます。設定した場合、date_range_ または RESERVED_ で始めることはできません。設定しない場合、分の範囲はリクエストのゼロベースのインデックス(date_range_0date_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)がリクエストされます。