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 句あり）と同様。このフィルタではディメンションを使用できません。
limit

string (int64 format)

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

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

enum (MetricAggregation)

指標の集計。集計された指標の値は、dimensionValues が「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)

ディメンションの列についての説明。DimensionHeaders の数と DimensionHeaders の順序は、行に存在するディメンションと一致します。
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

分の範囲

連続する分単位: 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 分間のイベントデータで任意の分をリクエストできます。また、360 のプロパティは過去 60 分間のイベントデータ（endMinutesAgo <= 59）をリクエストできます。endMinutesAgo <= 29