Google Analytics Realtime API は、プロパティのリアルタイム イベントデータのカスタム レポートを返します。これらのレポートには、過去 30 分間のイベントと使用状況が表示されます。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
イベントがトラッキングされる Google アナリティクス GA4 プロパティの識別子。本文ではなく URL パスで指定します。詳しくは、プロパティ ID を確認する方法をご覧ください。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 | |
---|---|
{ "dimensions": [ { object ( |
フィールド | |
---|---|
dimensions[] |
リクエストされ、表示されたディメンション。 |
metrics[] |
リクエストされ、表示される指標。 |
limit |
返される行数。 |
dimensionFilter |
ディメンションのフィルタ句。このフィルタで使用するディメンションをリクエストする必要があります。このフィルタでは指標を使用できません。 |
metricFilter |
指標のフィルタ句。SQL with 句と同様に、事後集計フェーズで適用されます。このフィルタで指標を使用するには、リクエストする必要があります。このフィルタではディメンションを使用できません。 |
metricAggregations[] |
指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。 |
orderBys[] |
レスポンス内の行の順序を指定します。 |
returnPropertyQuota |
このアナリティクス プロパティのリアルタイム割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。 |
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
リクエストに対応するレスポンスのリアルタイム レポートの表。
JSON 表現 | |
---|---|
{ "dimensionHeaders": [ { object ( |
フィールド | |
---|---|
dimensionHeaders[] |
ディメンションの列について説明します。DimensionHeaders の数と DimensionHeaders の順序が、行に存在するディメンションと一致している。 |
metricHeaders[] |
指標の列について説明します。MetricHeaders の数と MetricHeaders の順序は、行に存在する指標と一致します。 |
rows[] |
レポート内のディメンション値の組み合わせと指標値の行。 |
totals[] |
指標の合計値(リクエストされた場合)。 |
maximums[] |
指標の最大値(リクエストされた場合)。 |
minimums[] |
リクエストされた場合、指標の最小値。 |
rowCount |
レスポンスで返された行数に関係なく、クエリ結果の合計行数。たとえば、クエリが 175 行を返し、API リクエストに limit = 50 が含まれている場合、レスポンスには rowCount = 175 ですが、50 行のみが含まれます。 |
propertyQuota |
このリクエストを含む、このアナリティクス プロパティのリアルタイム割り当ての状態。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics