Method: properties.runRealtimeReport

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
property

string

イベントがトラッキングされる Google アナリティクスのプロパティの識別子。本文ではなく 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 は正の値にする必要があります。

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

enum (MetricAggregation)

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

object (OrderBy)

レスポンスで行を並べ替える方法を指定します。
returnPropertyQuota

boolean

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

object (MinuteRange)

読み取るイベントデータの分単位の範囲。指定しない場合は、過去 30 分間の 1 分間の範囲が使用されます。複数の分単位の範囲がリクエストされた場合、各レスポンス行には 0 から始まる分単位の範囲のインデックスが含まれます。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)

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

object (MetricHeader)

指標列について説明します。MetricHeaders の数と順序は、行に存在する指標と一致します。
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_ で始めることはできません。設定しない場合、分単位の範囲には、リクエスト内の 0 から始まるインデックス（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）をリクエストできます。