プロパティのリアルタイム イベントデータのカスタム レポートを返します。イベントは、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 with 句と同様に、事後集計フェーズで適用されます。このフィルタではディメンションを使用できません。 |
limit |
返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。 また、ディメンション値の数が |
metricAggregations[] |
指標の集計。集計された指標値は、dimensionValue が「RESERVED_(MetricAggregation)」に設定されている行に表示されます。 |
orderBys[] |
レスポンス内の行の順序を指定します。 |
returnPropertyQuota |
このアナリティクス プロパティのリアルタイム割り当ての現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。 |
minuteRanges[] |
読み取るイベントデータの分範囲。指定しない場合は、過去 30 分間の 1 分の範囲が使用されます。複数の分の範囲がリクエストされた場合、各レスポンスの行に 0 から始まる分の範囲インデックスが含まれます。2 つの分単位の期間が重複する場合、重複する分単位のイベントデータは、両方の分単位のレスポンス行に含まれます。 |
レスポンスの本文
リクエストに対応するレスポンスのリアルタイム レポートの表。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{ "dimensionHeaders": [ { object ( |
フィールド | |
---|---|
dimensionHeaders[] |
ディメンションの列について説明します。DimensionHeaders の数と 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 |
クエリの終了分を含む時間(分前)。 指定しない場合、 |