API を使用した二酸化炭素排出量のエクスポートと読み込み

Carbon Footprint には専用の公開 API がありません。ただし、BigQuery Data Transfer Service API を使用して二酸化炭素排出量をエクスポートしてから、BigQuery API を使用してデータをクエリできます。

BigQuery Data Transfer Service API の使用

BigQuery Data Transfer Service API を呼び出すには、付属のクライアント ライブラリを使用するか、REST API を直接呼び出します。

以下のドキュメントでは、REST API を使用して Carbon Footprint 転送構成とバックフィルを作成する方法について説明します。ただし、便宜上、選択した言語のクライアント ライブラリを使用して同等の API 呼び出しを行うことをおすすめします。

REST API を使用してエクスポートを作成する

次のペイロードを使用して、BigQuery Data Transfer Service API の transferConfigs.create エンドポイントを呼び出して転送を作成します。

{
  "dataSourceId": "61cede5a-0000-2440-ad42-883d24f8f7b8",
  "displayName": "NAME",
  "params": {
    "billing_accounts": "BILLING_ACCOUNT_IDS"
  },
  "destinationDatasetId": "DATASET"
}

次のように置き換えます。

  • NAME は、転送構成名に置き換えます。たとえば、「Company Carbon Report」です。
  • BILLING_ACCOUNT_IDS は、請求先アカウント ID に置き換えます。この値は、請求先アカウント ID のカンマ区切りリストにもできます。例: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET は、現在のプロジェクトの宛先 BigQuery データセット ID に置き換えます。例: company_carbon_report

転送構成が作成されると、翌月の 15 日に二酸化炭素データが自動的にエクスポートされます。履歴データをエクスポートする方法については、以下をご覧ください。

REST API を介して履歴データのバックフィルを実行する

既存の転送構成の過去の炭素データをエクスポートするには（上記を参照）、転送構成にバックフィルをリクエストする必要があります。

バックフィルを作成するには、前の手順（例: projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000 など）と次のペイロードで作成した転送の ID を使用して、POST リクエストを transferConfigs.startManualRuns エンドポイントに送信します。

{
  "requestedTimeRange": {
    "startTime": "<var>START_TIME</var>",
    "endTime": "<var>END_TIME</var>"
  }
}

ここで

  • START_TIME は、バックフィルする範囲の開始時間を指定するタイムスタンプです。 例: 2021-02-15T00:00:00Z2021 年 2 月 15 日には 2021 年 1 月のデータが含まれているため、ここで指定できる最も早い日付です。
  • END_TIME は、バックフィルする範囲の終了時間を指定するタイムスタンプです。例: 2022-09-15T00:00:00Z現在の日付を使用できます。

API を介して既存のエクスポートをクエリする

API にクエリを行う前に、エクスポートされたデータセットから目的のデータを返す SQL クエリを作成します。SQL クエリは BigQuery コンソールでテストできます。

BigQuery へのエクスポートを構成したら、BigQuery API または BigQuery ライブラリを使用してクエリを実行します。

次のステップ