Mengekspor dan membaca jejak karbon Anda menggunakan API

Jejak Karbon tidak memiliki API publik khusus. Namun, Anda dapat mengekspor jejak karbon melalui BigQuery Data Transfer Service API, lalu membuat kueri data menggunakan BigQuery API.

Menggunakan BigQuery Data Transfer Service API

Untuk memanggil BigQuery Data Transfer Service API, Anda dapat menggunakan library klien yang disediakan atau memanggil REST API secara langsung.

Dokumentasi di bawah menjelaskan cara membuat konfigurasi transfer dan pengisian ulang Jejak Karbon menggunakan REST API. Namun, untuk kemudahan, Anda dapat memilih untuk melakukan panggilan API yang setara menggunakan library klien dalam bahasa pilihan Anda.

Membuat ekspor melalui REST API

Panggil endpoint transferConfigs.create BigQuery Data Transfer Service API untuk membuat transfer, menggunakan payload berikut:

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

Ganti:

  • NAME dengan nama konfigurasi transfer Anda. Misalnya: "Laporan Karbon Perusahaan"
  • BILLING_ACCOUNT_IDS dengan ID akun penagihan Anda. Nilai ini dapat berupa daftar ID akun penagihan yang dipisahkan koma. Contoh: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET dengan ID set data BigQuery tujuan di project saat ini. Contoh: company_carbon_report

Setelah konfigurasi transfer dibuat, data karbon akan otomatis diekspor pada tanggal 15 setiap bulannya untuk bulan-bulan mendatang. Untuk mengekspor data historis, lihat di bawah.

Menjalankan pengisian ulang data historis melalui REST API

Untuk mengekspor data karbon historis untuk konfigurasi transfer yang ada (lihat di atas), Anda harus meminta pengisian ulang pada konfigurasi transfer.

Untuk membuat pengisian ulang, kirim permintaan POST ke endpoint transferConfigs.startManualRuns, menggunakan ID transfer yang dibuat di langkah sebelumnya (misalnya, projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) dan payload berikut:

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

Dengan keterangan:

  • START_TIME adalah stempel waktu yang menentukan waktu mulai rentang untuk pengisian ulang. Misalnya: 2021-02-15T00:00:00Z Perhatikan bahwa 15 Februari 2021 adalah tanggal awal yang dapat Anda tentukan di sini, karena berisi data Januari 2021.
  • END_TIME adalah stempel waktu yang menentukan waktu berakhir rentang untuk pengisian ulang. Misalnya: 2022-09-15T00:00:00Z Anda dapat menggunakan tanggal saat ini.

Membuat kueri ekspor yang ada melalui API

Sebelum membuat kueri API, tulis kueri SQL yang menampilkan data yang diinginkan dari set data yang diekspor. Anda dapat menguji kueri SQL di konsol BigQuery.

Setelah Anda mengonfigurasi ekspor ke BigQuery, gunakan BigQuery API atau library BigQuery untuk menjalankan kueri.

Apa langkah selanjutnya?