使用 API 匯出及讀取碳足跡資料

碳足跡沒有專屬的公開 API。 不過，您可以透過 BigQuery 資料移轉服務 API 匯出碳足跡，然後使用 BigQuery API 查詢資料。

使用 BigQuery 資料移轉服務 API

如要呼叫 BigQuery 資料移轉服務 API，可以使用提供的用戶端程式庫，或直接呼叫 REST API。

以下說明文件介紹如何使用 REST API 建立碳足跡轉移設定和回填。不過，為了方便起見，您可能會偏好使用所選語言的用戶端程式庫，發出對等的 API 呼叫。

透過 REST API 建立匯出作業

使用下列酬載，呼叫 BigQuery 資料移轉服務 API 的 transferConfigs.create 端點來建立移轉作業：

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

取代：

  • 將 NAME 替換為移轉設定名稱。例如：「公司碳排放報告」
  • 將 BILLING_ACCOUNT_IDS 改成您的帳單帳戶 ID。這個值可以是帳單帳戶 ID 的半形逗號分隔清單。例如：XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET，並在目前專案中提供目的地 BigQuery 資料集 ID。例如：company_carbon_report

建立移轉設定後，系統會在每個月 15 日自動匯出所有後續月份的碳排放量資料。如要匯出歷來資料，請參閱下文。

透過 REST API 執行歷來資料補充作業

如要匯出現有移轉設定的歷史碳排放量資料 (如上所述)，您必須要求回填移轉設定。

如要建立回填，請使用上一個步驟中建立的轉移作業 ID (例如 projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) 和下列酬載，將 POST 要求傳送至 transferConfigs.startManualRuns 端點：

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

其中：

  • START_TIME 是時間戳記，用來指定要回填的範圍開始時間。例如：2021-02-15T00:00:00Z。請注意，這裡可指定的最早日期是 2021 年 2 月 15 日，因為這段期間包含 2021 年 1 月的資料。
  • END_TIME 是時間戳記，用來指定要回填的範圍結束時間。例如：2022-09-15T00:00:00Z。您可以使用目前日期。

透過 API 查詢現有匯出作業

查詢 API 前，請先撰寫 SQL 查詢，從匯出的資料集傳回所需資料。您可以在 BigQuery 控制台中測試 SQL 查詢。

設定匯出至 BigQuery 的資料後，請使用 BigQuery API 或 BigQuery 程式庫執行查詢。

後續步驟