Method: properties.runRealtimeReport

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスの GA4 プロパティの識別子。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-clause と同様に、集計後のフェーズで適用されます。このフィルタで指標を使用するには、指標をリクエストする必要があります。このフィルタではディメンションを使用できません。

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

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

returnPropertyQuota

boolean

このアナリティクス プロパティのリアルタイム割り当ての現在の状態を返すかどうかを切り替えます。割り当ては 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)

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

metricHeaders[]

object (MetricHeader)

指標の列について説明します。MetricHeaders の数と MetricHeaders の順序は、行に存在する指標と一致します。

rows[]

object (Row)

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

totals[]

object (Row)

指標の合計値(リクエストされた場合)。

maximums[]

object (Row)

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

minimums[]

object (Row)

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

rowCount

integer

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

propertyQuota

object (PropertyQuota)

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

認可スコープ

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

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