プロパティのリアルタイム イベントデータを集めたカスタム レポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイム レポートに表示されます。リアルタイム レポートには、現在から 30 分前(Google アナリティクス 360 プロパティの場合は最長 60 分)の期間のイベントと使用状況データが表示されます。
リアルタイムのリクエストの作成とレスポンスの理解のガイドについては、リアルタイム レポートの作成をご覧ください。
HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
property |
イベントがトラッキングされる Google アナリティクスの GA4 プロパティの識別子。URL パスで指定し、本文では指定しない。詳しくは、プロパティ ID を確認する方法をご覧ください。 例: properties/1234 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensions": [ { object ( |
フィールド | |
---|---|
dimensions[] |
リクエストおよび表示されるディメンション。 |
metrics[] |
リクエストされて表示される指標。 |
dimensionFilter |
ディメンションのフィルタ句。このフィルタでは指標を使用できません。 |
metricFilter |
指標のフィルタ句。SQL has-clause と同様に、集計後のフェーズで適用されます。このフィルタではディメンションを使用できません。 |
limit |
返される行数です。指定しない場合は、10,000 行が返されます。リクエストの数に関係なく、API はリクエストあたり最大 250,000 行を返します。 ディメンション値の数が |
metricAggregations[] |
指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。 |
orderBys[] |
レスポンス内の行の順序を指定します。 |
returnPropertyQuota |
このアナリティクス プロパティのリアルタイム割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota に返されます。 |
minuteRanges[] |
読み取るイベントデータの分範囲。指定しない場合は、過去 30 分間の 1 分の範囲が使用されます。複数の分範囲がリクエストされた場合、各レスポンス行にはゼロベースの分範囲インデックスが含まれます。2 つの分範囲が重複する場合、重複する分単位のイベントデータは、両方の分範囲のレスポンス行に含まれます。 |
レスポンスの本文
リクエストに対応するレスポンスのリアルタイム レポート テーブル。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensionHeaders": [ { object ( |
フィールド | |
---|---|
dimensionHeaders[] |
ディメンション列について説明します。ディメンションヘッダーの数と ディメンションヘッダーの順序が、行のディメンションと一致しています。 |
metricHeaders[] |
指標の列について説明します。MetricHeaders の数と MetricHeaders の順序は、行に存在する指標と一致します。 |
rows[] |
レポートのディメンション値の組み合わせと指標値の行。 |
totals[] |
指標の合計値(リクエストされた場合)。 |
maximums[] |
リクエストされた場合、指標の最大値。 |
minimums[] |
リクエストされた場合、指標の最小値。 |
rowCount |
クエリ結果の合計行数。 |
propertyQuota |
このリクエストを含む、このアナリティクスのプロパティのリアルタイム割り当て状態。 |
kind |
このメッセージのリソースの種類を表します。この |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
MinuteRange
連続した時間セット: startMinutesAgo
、startMinutesAgo + 1
、...、endMinutesAgo
。リクエストの範囲は最大 2 分です。
JSON 表現 |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
フィールド | |
---|---|
name |
この時間の範囲に名前を割り当てます。レポートのレスポンスでは、ディメンション |
startMinutesAgo |
クエリの開始時間を分単位で示したもの。たとえば、 指定しない場合、 |
endMinutesAgo |
クエリの終了時刻(分数、現在から何分前も含む)。 指定しない場合、 |