CO2-Bilanz mit einer API exportieren und lesen

Carbon Footprint hat keine dedizierte öffentliche API. Sie können Ihre CO2-Bilanz jedoch über die BigQuery Data Transfer Service API exportieren und die Daten dann über die BigQuery API abfragen.

BigQuery Data Transfer Service API verwenden

Zum Aufrufen der BigQuery Data Transfer Service API können Sie die bereitgestellten Clientbibliotheken verwenden oder die REST API direkt aufrufen.

In der folgenden Dokumentation wird beschrieben, wie Sie mit der REST API Carbon Footprint-Übertragungskonfigurationen und -Backfills erstellen. Der Einfachheit halber bevorzugen Sie es jedoch vielleicht, die entsprechenden API-Aufrufe mithilfe der Clientbibliothek in der Sprache Ihrer Wahl auszuführen.

Export über die REST API erstellen

Rufen Sie den Endpunkt transferConfigs.create der BigQuery Data Transfer Service API auf, um eine Übertragung zu erstellen. Verwenden Sie dazu die folgende Nutzlast:

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

Ersetzen Sie:

  • NAME durch den Namen Ihrer Übertragungskonfiguration. Beispiel: „CO2-Bericht des Unternehmens“
  • BILLING_ACCOUNT_IDS durch Ihre Rechnungskonto-ID. Dieser Wert kann eine durch Kommas getrennte Liste von Rechnungskonto-IDs sein. Beispiel: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET durch die ID des BigQuery-Ziel-Datasets im aktuellen Projekt. Beispiel: company_carbon_report

Nachdem die Übertragungskonfiguration erstellt wurde, werden die CO2-Daten für alle zukünftigen Monate automatisch am 15. des Monats exportiert. Wie Sie Verlaufsdaten exportieren, erfahren Sie unten.

Backfill von Verlaufsdaten über die REST API ausführen

Zum Exportieren bisheriger CO2-Daten für eine vorhandene Übertragungskonfiguration (siehe oben) müssen Sie einen Backfill für Ihre Übertragungskonfiguration anfordern.

Senden Sie zum Erstellen eines Backfills eine POST-Anfrage an den Endpunkt transferConfigs.startManualRuns. Verwenden Sie dabei die ID der im vorherigen Schritt erstellten Übertragung (z. B. projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) und die folgende Nutzlast:

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

Wobei:

  • START_TIME ist ein Zeitstempel, der die Startzeit des Bereichs für den Backfill angibt. Beispiel: 2021-02-15T00:00:00Z. Beachten Sie, dass der 15. Februar 2021 das früheste Datum ist, das Sie hier angeben können, da es die Daten vom Januar 2021 enthält.
  • END_TIME ist ein Zeitstempel, der die Endzeit des Bereichs für den Backfill angibt. Beispiel: 2022-09-15T00:00:00Z. Sie können das aktuelle Datum verwenden.

Vorhandenen Export über die API abfragen

Schreiben Sie vor dem Abfragen der API eine SQL-Abfrage, die die gewünschten Daten aus dem exportierten Dataset zurückgibt. Sie können die SQL-Abfrage in der BigQuery-Konsole testen.

Nachdem Sie einen Export nach BigQuery konfiguriert haben, verwenden Sie die BigQuery API oder die BigQuery-Bibliotheken, um die Abfrage auszuführen.

Nächste Schritte