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 としてカウントされます。

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

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

string (int64 format)

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

limit と同じ数のディメンション値がない場合、API から返される行数がリクエストされた limit よりも少なくなることもあります。QueryReportTaskRequest で使用できる行数は、関連付けられた ReportTask の上限によってさらに制限されます。クエリで取得できる行数は、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 の数と順序が、行に存在するディメンションと一致している。
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,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
フィールド
dataLossFromOtherRow

boolean

true の場合、ディメンションの組み合わせの一部のバケットが「（other）」行に統合されています。これは、基数の大きいレポートで発生する可能性があります。

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

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

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

object (SamplingMetadata)

このレポートの結果がサンプリングされている場合は、このレポートで使用されるイベントの割合を示します。期間ごとに 1 つの samplingMetadatas が入力されます。各 samplingMetadatas は、リクエストで指定された期間に対応しています。

ただし、結果がサンプリングされていない場合、このフィールドは定義されません。
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

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

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