Method: properties.runRealtimeReport

プロパティのリアルタイム イベントデータのカスタマイズされたレポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイム レポートに表示されます。リアルタイム レポートには、現在から 30 分前（Google アナリティクス 360 プロパティでは最大 60 分前）の期間のイベントと使用状況データが表示されます。

リアルタイム リクエストの作成とレスポンスの理解に関するガイドについては、リアルタイム レポートの作成をご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

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

例: properties/1234

リクエスト本文

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

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

object (Dimension)

リクエストされ、表示されるディメンション。
metrics[]

object (Metric)

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

object (FilterExpression)

ディメンションのフィルタ句。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

指標のフィルタ句。SQL の HAVING 句と同様に、集計後のフェーズで適用されます。このフィルタではディメンションを使用できません。
limit

string (int64 format)

返す行数。指定しない場合、10,000 行が返されます。API は、リクエストに応じて最大 250,000 行を返します。limit には正の値を指定してください。

limit と同じ数のディメンション値がない場合、API から返される行数がリクエストされた limit よりも少なくなることもあります。たとえば、ディメンション country の有効な値は 300 未満であるため、country のみをレポートする場合、limit をより大きい値に設定しても、300 行を超える行を取得することはできません。
metricAggregations[]

enum (MetricAggregation)

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

object (OrderBy)

レスポンスで行の並べ替え順序を指定します。
returnPropertyQuota

boolean

この Google アナリティクス プロパティのリアルタイム クォータの現在の状態を返すかどうかを切り替えます。割り当ては PropertyQuota で返されます。
minuteRanges[]

object (MinuteRange)

読み取るイベントデータの分単位の範囲。指定しない場合、過去 30 分間の 1 分間範囲が使用されます。複数の分範囲がリクエストされた場合、各レスポンス行にはゼロベースの分範囲インデックスが含まれます。2 つの分範囲が重複する場合、重複する分のイベントデータは、両方の分範囲のレスポンス行に含まれます。

レスポンスの本文

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

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

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

object (DimensionHeader)

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

object (MetricHeader)

指標列を記述します。MetricHeader の数と MetricHeader の順序が、行に存在する指標と一致している。
rows[]

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

クエリ結果の行の合計数。rowCount は、レスポンスで返される行数や limit リクエスト パラメータとは独立しています。たとえば、クエリが 175 行を返し、API リクエストに 50 の limit が含まれている場合、レスポンスには 175 の rowCount が含まれますが、行は 50 行のみです。
propertyQuota

object (PropertyQuota)

この Google アナリティクス プロパティのリアルタイム クォータの状態（このリクエストを含む）。
kind

string

このメッセージのリソースの種類を示します。この kind は常に固定文字列「analyticsData#runRealtimeReport」です。JSON でレスポンス タイプを区別する場合に便利です。

認可スコープ

次の 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

string

この分単位の範囲に名前を割り当てます。レポート レスポンスでは、ディメンション dateRange の値がこの名前になります。設定する場合は、date_range_ または RESERVED_ で始めることはできません。設定されていない場合、分範囲にはリクエスト内のゼロベースのインデックス（date_range_0、date_range_1 など）が名前として付けられます。
startMinutesAgo

integer

クエリの開始時間（現在からの分数）。たとえば、"startMinutesAgo": 29 は、レポートに 29 分前以降のイベントデータが含まれることを指定します。endMinutesAgo より後の日付は指定できません。

指定しない場合、startMinutesAgo はデフォルトで 29 になります。標準のアナリティクス プロパティでは、過去 30 分間のイベントデータ（startMinutesAgo <= 29）をリクエストできます。アナリティクス 360 プロパティでは、過去 60 分間のイベントデータ（startMinutesAgo <= 59）をリクエストできます。
endMinutesAgo

integer

クエリの終了時間（現在からの分数）。startMinutesAgo より前の日付は指定できません。たとえば、"endMinutesAgo": 15 は、レポートに 15 分前より前のイベントデータを含めるように指定します。

指定しない場合、endMinutesAgo はデフォルトで 0 になります。標準アナリティクスのプロパティでは、過去 30 分間のイベントデータの任意の分（endMinutesAgo <= 29）をリクエストできます。アナリティクス 360 のプロパティでは、過去 60 分間のイベントデータの任意の分（endMinutesAgo <= 59）をリクエストできます。