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 を 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)

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

object (MetricHeader)

指標の列について説明します。MetricHeader の数と MetricHeader の順序は、行にある指標と一致します。
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」または「アジア/東京」。
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 など）。