Method: properties.reportTasks.query

レポートタスクの内容を取得します。reportTasks.create をリクエストした後、レポートが有効になると、レポートの内容を取得できます。レポートタスクの状態が ACTIVE でない場合、このメソッドはエラーを返します。クエリ レスポンスは、レポートの行と列の表形式の値を返します。

HTTP リクエスト

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

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

パスパラメータ

パラメータ
name

string

必須。レポートソースの名前。形式: properties/{property}/reportTasks/{report}

リクエスト本文

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

JSON 表現 
{
  "offset": string,
  "limit": string
}
フィールド
offset

string (int64 format)

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

ページングの際に、最初のリクエストで offset が指定されていません。または、これと同等に、offset を 0 に設定します。最初のリクエストは、行の最初の limit を返します。2 番目のリクエストは、最初のリクエストの limit にオフセットを設定します。2 番目のリクエストは行の 2 番目の limit を返します。

このページ設定パラメータの詳細については、ページ設定をご覧ください。
limit

string (int64 format)

省略可。レポートから返される行数。指定しない場合は、10,000 行が返されます。API は、リクエストした数に関係なく、リクエストあたり最大 250,000 行を返します。limit は正数でなければなりません。

また、ディメンション値の数が limit より少ない場合、API はリクエストされた limit よりも少ない行を返すことがあります。QueryReportTaskRequest で使用できる行数は、関連する ReportTask の上限によってさらに制限されます。1 つのクエリで取得できる行は ReportTask.limit 行までです。たとえば、ReportTask の上限が 1,000 の場合、offset=900 と limit=500 を指定して reportTasks.query リクエストを行うと、最大で 100 行が返されます。

このページ設定パラメータの詳細については、ページ設定をご覧ください。

レスポンスの本文

レポートタスクに対応するレポート コンテンツ。

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

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

object (DimensionHeader)

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

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

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

object (Row)

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

integer

クエリ結果の行の合計数。
metadata

object (ResponseMetaData)

レポートのメタデータ。

認可スコープ

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

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

ResponseMetaData

レポートの内容に関する追加情報を含むレスポンスのメタデータ。

JSON 表現 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
フィールド
dataLossFromOtherRow

boolean

true の場合、ディメンションの組み合わせの一部のバケットが「（other）」行にまとめられることを示します。これは、カーディナリティが高いレポートで発生する可能性があります。

メタデータ パラメータ dataLossFromOtherRow は、レポートで使用されている集計データテーブルに基づいて入力されます。レポートのフィルタや制限に関係なく、パラメータは正確に入力されます。

たとえば、「sessionSource = google」というフィルタがリクエストに含まれているため、「（other）」行がレポートから削除される可能性があります。このレポートの生成に使用された集計データに、他の行からのデータ損失があった場合、このパラメータは入力されます。

詳しくは、「（other）」行とデータ サンプリングについてをご覧ください。
schemaRestrictionResponse

object (SchemaRestrictionResponse)

このレポートの作成時にアクティブに適用されるスキーマ制限を表します。詳しくは、アクセス権とデータ制限の管理をご覧ください。
currencyCode

string

このレポートで使用される通貨コード。可視化のために purchaseRevenue などの通貨指標の形式を設定するために使用することを目的としています。リクエストで currencyCode が指定されている場合、このレスポンス パラメータはリクエスト パラメータをエコーします。それ以外の場合は、プロパティの現在の currencyCode になります。

通貨コードは、ISO 4217 標準（https://en.wikipedia.org/wiki/ISO_4217)）の通貨の種類を文字列でエンコードしたものです。たとえば、「USD」、「EUR」、「JPY」などです。詳しくは、https://support.google.com/analytics/answer/9796179 をご覧ください。
timeZone

string

プロパティの現在のタイムゾーン。hour や minute などの時間ベースのディメンションの解釈に使用することを目的としています。IANA タイムゾーン データベース（https://www.iana.org/time-zones)の文字列としてフォーマットされます。たとえば、「America/New_York」や「Asia/Tokyo」などです。
emptyReason

string

理由が空の場合、レポートはこの理由で空になります。
subjectToThresholding

boolean

subjectToThresholding が true の場合、このレポートはしきい値の適用対象となり、集計の最小しきい値を満たすデータのみを返します。リクエストにしきい値のしきい値が適用され、レポートにないデータがないという場合があります。これは、すべてのデータがしきい値を超えた場合に起こります。詳しくは、データのしきい値とユーザー属性とインタレスト カテゴリについてをご覧ください。

SchemaRestrictionResponse

このレポートの作成時にアクティブになっているスキーマ制限。詳しくは、アクセス権とデータ制限の管理をご覧ください。

JSON 表現 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
フィールド
activeMetricRestrictions[]

object (ActiveMetricRestriction)

レポートの作成時にアクティブに適用されるすべての制限。たとえば、purchaseRevenue の制限タイプは常に REVENUE_DATA です。ただし、このアクティブなレスポンスの制限は、ユーザーのカスタムロールで REVENUE_DATA へのアクセスが許可されていない場合にのみ入力されます。

ActiveMetricRestriction

レポートの作成時にアクティブに制限された指標。

JSON 表現 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
フィールド
restrictedMetricTypes[]

enum (RestrictedMetricType)

この指標の制限理由。
metricName

string

制限付き指標の名前。

RestrictedMetricType

特定の GA4 プロパティで表示が制限される可能性があるデータのカテゴリ。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED 未指定のタイプ。
COST_DATA 費用指標（adCost など）。
REVENUE_DATA 収益指標（purchaseRevenue など）。