レポートタスクの基礎

レポートタスクを使用すると、長時間実行の非同期リクエストを開始して、 Google アナリティクスのイベントデータのカスタム レポート

このリクエストから生成されたレポートタスク リソースを使用すると、 Google アナリティクスへの読み取りアクセス権限を持つすべてのユーザーによるカスタマイズされたレポート プロパティです。

カスタム レポートは、準備が整ってから 72 時間有効です。この後 対応するレポートタスク リソースとその内容が 削除されます。

レポートタスクを作成する

Google アナリティクス Data API v1 では、 レポートタスクを作成します。まず、外部 IP アドレスから reportTasks.create メソッドが必要です。次に、 reportTasks.query メソッドを使用して、生成されたカスタム レポートを取得します。

また、 reportTasks.get 特定のレポート タスクに関する構成メタデータを取得したり、 reportTasks.list を使用して、プロパティのすべてのレポートタスクを一覧表示します。

レポート エンティティを選択

Data API v1 のすべてのメソッドには、 Google アナリティクスのプロパティ ID URL リクエストパス内で properties/GA_PROPERTY_ID。例:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

レポートは Google アナリティクスのイベントに基づいて生成される データが収集されます。

Data API クライアント ライブラリのいずれかを使用している場合は、 リクエスト URL パスを手動で操作する必要はありません。 ほとんどの API クライアントは、property パラメータを properties/GA_PROPERTY_ID 形式の文字列。 例については、クイック スタートガイドをご覧ください。 基本的な使用方法を見ていきましょう。

レポートタスクの作成をリクエストする

Report タスクを作成するには、 reportTasks.create メソッド ReportTask 必要があります。次のパラメータを指定します。

レポートタスク作成リクエストの例:

HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
  "reportDefinition": {
    "dateRanges": [{ "startDate": "2024-05-01"", "endDate": "2024-05-15" }],
    "dimensions": [{ "name": "country" }],
    "metrics": [{ "name": "activeUsers" }]
  }
}

reportTasks.create メソッドのレスポンスには、レポートが含まれます。 name フィールドのタスク名（ properties/1234567/reportTasks/123）があります。これは次のリソースで使用できます。 後続のクエリで Report Task のステータスを取得し、 表示されます。

HTTP レスポンス
{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
    "name": "properties/1234567/reportTasks/123",
    "reportDefinition": {
      "dimensions": [
        {
          "name": "country"
        }
      ],
      "metrics": [
        {
          "name": "activeUsers"
        }
      ],
      "dateRanges": [
        {
          "startDate": "2024-05-01",
          "endDate": "2024-05-15"
        }
      ]
    },
    "reportMetadata": {
      "state": "CREATING",
      "beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
    }
  }
}

レポートタスクの準備状態を取得する

レポートが生成されるまで、数分かかる場合があります。 reportTasks.create あります。Report タスクの準備状態を取得するには、 reportTasks.get メソッドを呼び出します。

レポートタスク名を使用する（properties/1234567/reportTasks/123 など） reportTasks.create レスポンスから受信した タスクを報告します。

例:

HTTP リクエスト
GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

レポートタスクの準備状況は、 state フィールドで確認できます。レポートの生成が完了すると レポートタスクの状態が CREATING から ACTIVE に変わります。

reportMetadata フィールドには、生成されたレポートに関する 行数と課金されるクォータ トークンの金額などです。

HTTP レスポンス
{
  "reportDefinition": {
    "dimensions": [
      {
        "name": "country"
      }
    ],
    "metrics": [
      {
        "name": "activeUsers"
      }
    ],
    "dateRanges": [
      {
        "startDate": "2024-05-01",
        "endDate": "2024-05-15"
      }
    ]
  },
  "reportMetadata": {
    "state": "ACTIVE",
    "beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
    "creationQuotaTokensCharged": 6,
    "taskRowCount": 167,
    "errorMessage": "",
    "totalRowCount": 167
  }
}

すべての Report タスクの状態を取得するには、 reportTasks.list メソッドを呼び出します。

生成されたレポートを取得する

モジュールを使用してレポートタスクが作成されたら、 reportTasks.create メソッドが生成されたら、 reportTasks.query メソッドを呼び出し、Report Task 名を （properties/1234567/reportTasks/123 など）。

HTTP リクエスト
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query

レポートタスクの準備が整うと、生成されたレポートを含むレスポンスが返されます。

HTTP レスポンス
{
  "dimensionHeaders": [
    {
      "name": "country"
    }
  ],
  "metricHeaders": [
    {
      "name": "activeUsers",
      "type": "TYPE_INTEGER"
    }
  ],
  "rows": [

...

  ],
  "rowCount": 167,
  "metadata": {
    "currencyCode": "USD",
    "timeZone": "America/Los_Angeles"
  }
}