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 mit der BigQuery API abfragen.

BigQuery Data Transfer Service API verwenden

Sie können die BigQuery Data Transfer Service API über die bereitgestellten Clientbibliotheken oder direkt über die REST API aufrufen.

In der folgenden Dokumentation wird beschrieben, wie Sie eine Carbon Footprint erstellen. Übertragungskonfigurationen und Backfills mithilfe der REST API. Aus praktischen Gründen können Sie die entsprechenden API-Aufrufe jedoch auch über die Clientbibliothek in Ihrer gewünschten Sprache ausführen.

Export über die REST API erstellen

Rufen Sie den Endpunkt transferConfigs.create auf. der BigQuery Data Transfer Service API, um mit dem folgenden Befehl eine Übertragung zu erstellen: 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: „Carbon-Bericht des Unternehmens“
  • BILLING_ACCOUNT_IDS durch Ihre Rechnungskonto-ID. Dieser Wert kann ein kommagetrennte Liste von Rechnungskonto-IDs. Beispiel: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET durch die ID des Ziel-BigQuery-Datasets im aktuellen Projekt. Beispiel: company_carbon_report

Nachdem die Übertragungskonfiguration erstellt wurde, werden CO2-Daten automatisch exportiert am 15. des Monats für alle zukünftigen Monate. Weitere Informationen zum Exportieren von Verlaufsdaten finden Sie unten.

Backfill von Verlaufsdaten über die REST API ausführen

Wenn Sie bisherige CO₂-Daten für eine vorhandene Übertragungskonfiguration exportieren möchten (siehe oben), müssen Sie einen Backfill für Ihre Übertragungskonfiguration anfordern.

Um einen Backfill zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt transferConfigs.startManualRuns. Verwenden Sie dabei die ID der Übertragung, die Sie im vorherigen Schritt erstellt haben (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 zu ergänzenden Zeitraums angibt. Beispiel: 2021-02-15T00:00:00Z. Das früheste Datum, das Sie hier angeben können, ist der 15. Februar 2021, da es die Daten für Januar 2021 enthält.
  • END_TIME ist ein Zeitstempel gibt die Endzeit des Bereichs für den Backfill an. Beispiel: 2022-09-15T00:00:00Z. Sie können das aktuelle Datum verwenden.

Vorhandenen Export über die API abfragen

Bevor Sie die API abfragen, schreiben Sie eine SQL-Abfrage, die die gewünschten Daten aus dem exportierten Datensatz zurückgibt. Sie können die SQL-Abfrage in der BigQuery-Konsole:

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

Nächste Schritte