Esportare e leggere l'impronta di carbonio utilizzando un'API

Carbon Footprint non ha un'API pubblica dedicata. Tuttavia, puoi esportare l'impronta di carbonio tramite l'API BigQuery Data Transfer Service e poi eseguire query sui dati utilizzando l'API BigQuery.

Utilizzo dell'API BigQuery Data Transfer Service

Per chiamare l'API BigQuery Data Transfer Service, puoi utilizzare le librerie client fornite o chiamare direttamente l'API REST.

La documentazione riportata di seguito descrive come creare configurazioni di trasferimento e backfill dell'impronta di carbonio utilizzando l'API REST. Tuttavia, per comodità, potresti preferire effettuare le chiamate API equivalenti utilizzando la libreria client nella lingua che preferisci.

Creare un'esportazione tramite l'API REST

Chiama l'endpoint transferConfigs.create dell'API BigQuery Data Transfer Service per creare un trasferimento utilizzando il seguente payload:

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

Sostituisci:

  • NAME con il nome della configurazione di trasferimento. Ad esempio: "Report sul carbonio dell'azienda"
  • BILLING_ACCOUNT_IDS con il tuo ID account di fatturazione. Questo valore può essere un elenco separato da virgole di ID account fatturazione. Ad esempio: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET con l'ID del set di dati BigQuery di destinazione nel progetto corrente. Ad esempio: company_carbon_report

Una volta creata la configurazione del trasferimento, i dati sul carbonio verranno esportati automaticamente il 15 del mese per tutti i mesi futuri. Per esportare i dati storici, consulta quanto segue.

Esegui un backfill dei dati storici tramite l'API REST

Per esportare i dati storici sul carbonio per una configurazione di trasferimento esistente (vedi sopra), devi richiedere un backfill per la configurazione di trasferimento.

Per creare un backfill, invia una richiesta POST all'endpoint transferConfigs.startManualRuns, utilizzando l'identificatore del trasferimento creato nel passaggio precedente (ad esempio projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) e il seguente payload:

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

Dove:

  • START_TIME è un timestamp che specifica l'ora di inizio dell'intervallo da eseguire il backfill. Ad esempio: 2021-02-15T00:00:00Z. Tieni presente che il 15 febbraio 2021 è la data più antica che puoi specificare qui, poiché contiene i dati di gennaio 2021.
  • END_TIME è un timestamp che specifica l'ora di fine dell'intervallo da eseguire il backfill. Ad esempio: 2022-09-15T00:00:00Z. Puoi utilizzare la data corrente.

Esegui una query su un'esportazione esistente tramite l'API

Prima di eseguire query sull'API, scrivi una query SQL che restituisca i dati desiderati dal set di dati esportato. Puoi testare la query SQL nella console BigQuery.

Dopo aver configurato un'esportazione in BigQuery, utilizza l'API BigQuery o le librerie BigQuery per eseguire la query.

Passaggi successivi