Method: properties.runRealtimeReport

Google アナリティクス Realtime API は、プロパティのリアルタイム イベントデータのカスタム レポートを返します。これらのレポートには、過去 30 分間のイベントと使用状況が表示されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

JSON 表現 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
フィールド
dimensions[]

object (Dimension)

リクエストして表示されたディメンション。
metrics[]

object (Metric)

リクエストされ、表示される指標。
limit

string (int64 format)

返される行数。limit パラメータが指定されていない場合、10,000 行が返されます。この API では、指定した行数に関係なく、リクエストごとに最大 100,000 行が返されます。
dimensionFilter

object (FilterExpression)

ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL の has 句と同様に、集計後のフェーズで適用されます。このフィルタで使用するには、指標をリクエストする必要があります。このフィルタではディメンションを使用できません。
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

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

boolean

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

レスポンスの本文

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

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

JSON 表現 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
フィールド
dimensionHeaders[]

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

クエリ結果の行の合計数。レスポンスで返される行数は関係ありません。たとえば、API リクエストで 175 行を返すクエリで limit = 50 が含まれている場合、レスポンスには rowCount = 175 が含まれますが、50 行のみが含まれます。
propertyQuota

object (PropertyQuota)

このリクエストを含む、このアナリティクス プロパティのリアルタイムの割り当て状態。

認可スコープ

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

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