Method: properties.runReport

Google アナリティクス イベント データのカスタム レポートを返します。レポートには、Google アナリティクスのトラッキング コードで収集されたデータから導き出された統計情報が含まれます。API から返されるデータは、リクエストされたディメンションと指標の列を含む表形式です。指標は、プロパティでのユーザー アクティビティの個々の測定値（アクティブ ユーザー数やイベント数など）です。ディメンションは、国やイベント名などの一般的な条件で指標の内訳を表示します。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runReport

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

パスパラメータ

パラメータ
property

string

必須。イベントがトラッキングされる Google アナリティクスのプロパティの ID。URL パスで指定され、本文では指定されていません。詳しくは、プロパティ ID を確認するをご覧ください。バッチ リクエスト内では、このプロパティは指定しないか、バッチレベルのプロパティと一致している必要があります。

例: properties/1234

リクエストの本文

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

JSON 表現 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
フィールド
dimensions[]

object (Dimension)

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

object (Metric)

省略可。リクエストされて表示される指標。
dateRanges[]

object (DateRange)

省略可。読み取るデータの期間。複数の期間がリクエストされた場合、各レスポンス行には 0 ベースの期間インデックスが含まれます。2 つの日付範囲が重複している場合、重複する日のイベントデータは、両方の日付範囲のレスポンス行に含まれます。コホート リクエストでは、この dateRanges は指定しないようにしてください。
dimensionFilter

object (FilterExpression)

省略可。ディメンション フィルタを使用すると、レポートで特定のディメンション値のみをリクエストできます。詳細については、ディメンション フィルタの基本の例をご覧ください。このフィルタでは指標を使用できません。
metricFilter

object (FilterExpression)

省略可。指標のフィルタ句。レポートの行を集計した後に適用されます。SQL の having 句に似ています。このフィルタではディメンションを使用できません。
offset

string (int64 format)

省略可。開始行の行数。最初の行は行 0 としてカウントされます。

ページングを行う場合、最初のリクエストではオフセットを指定しません。つまり、オフセットを 0 に設定します。最初のリクエストは、最初の limit 行を返します。2 番目のリクエストは、オフセットを最初のリクエストの limit に設定します。2 番目のリクエストは、2 番目の limit 行を返します。

このページネーション パラメータの詳細については、ページネーションをご覧ください。
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)

省略可。レスポンスで行が並べ替えられる方法を指定します。比較と複数の期間の両方を含むリクエストでは、比較に order by が適用されます。
currencyCode

string

省略可。ISO4217 形式の通貨コード（「AED」、「USD」、「JPY」など）。このフィールドが空の場合、レポートではプロパティのデフォルトの通貨が使用されます。
cohortSpec

object (CohortSpec)

省略可。このリクエストに関連付けられているコホート グループ。リクエストにコホート グループがある場合は、「コホート」ディメンションが存在する必要があります。
keepEmptyRows

boolean

省略可。false または未指定の場合、すべての指標が 0 の行は返されません。true の場合、これらの行はフィルタで個別に削除されない限り返されます。

この keepEmptyRows 設定にかかわらず、レポートに表示できるのは Google アナリティクスのプロパティで記録されたデータのみです。

たとえば、プロパティで purchase イベントが記録されない場合、eventName ディメンションと eventCount 指標のクエリには、eventName: "purchase" と eventCount: 0 の行は含まれません。
returnPropertyQuota

boolean

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

object (Comparison)

省略可。リクエストされた比較の構成が表示されます。リクエストで比較列をレスポンスで受け取るために必要なのは、比較フィールドのみです。
conversionSpec

object (ConversionSpec)

省略可。コンバージョン レポートを制御します。このフィールドは省略可能です。このフィールドが設定されているか、コンバージョン指標がリクエストされている場合、レポートはコンバージョン レポートになります。

レスポンスの本文

リクエストに対応するレスポンス レポート テーブル。

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

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

object (DimensionHeader)

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

object (MetricHeader)

指標列について説明します。MetricHeader の数と順序は、行に存在する指標と一致します。
rows[]

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

レスポンスで返される行数に関係なく、クエリ結果の行の合計数。たとえば、クエリが 175 行を返し、API リクエストに limit = 50 が含まれている場合、レスポンスには rowCount = 175 が含まれますが、行数は 50 行のみになります。

このページネーション パラメータの詳細については、ページネーションをご覧ください。
metadata

object (ResponseMetaData)

レポートのメタデータ。
propertyQuota

object (PropertyQuota)

このリクエストを含む、このアナリティクス プロパティの割り当て状態。
kind

string

このメッセージがどの種類のリソースであるかを示します。この kind は常に固定文字列「analyticsData#runReport」です。JSON でレスポンス タイプを区別するのに役立ちます。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

比較

個々の比較を定義します。ほとんどのリクエストには複数の比較が含まれるため、レポートでは比較間の比較が行われます。

JSON 表現 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
フィールド
name

string

比較ごとに、レスポンスに個別の行が生成されます。レスポンスでは、この比較はこの名前で識別されます。名前が指定されていない場合は、保存された比較の表示名が使用されます。

共用体フィールド one_comparison。

one_comparison は次のいずれかになります。
dimensionFilter

object (FilterExpression)

基本的な比較。
comparison

string

比較のリソース名で識別される保存済みの比較。例: 「comparisons/1234」。

ConversionSpec

コンバージョン レポートを制御します。

JSON 表現 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
フィールド
conversionActions[]

string

レポートに含めるコンバージョン アクション ID。空の場合、すべてのコンバージョンが対象となります。有効なコンバージョン アクション ID は、properties.getMetadata メソッドのレスポンスの conversions リスト内の conversionAction フィールドから取得できます。例: 「conversionActions/1234」。
attributionModel

enum (AttributionModel)

コンバージョン レポートで使用するアトリビューション モデル。指定しない場合は DATA_DRIVEN が使用されます。

AttributionModel

コンバージョン レポートで使用するアトリビューション モデル

列挙型
ATTRIBUTION_MODEL_UNSPECIFIED アトリビューション モデルが指定されていません。
DATA_DRIVEN アトリビューションは有料とオーガニック データに基づいたデータドリブン モデルでした
LAST_CLICK アトリビューションは有料およびオーガニックのラストクリック モデルに基づいて行われました