Exporter et lire votre empreinte carbone à l'aide d'une API

L'empreinte carbone ne dispose pas d'API publique dédiée. Toutefois, vous pouvez exporter votre empreinte carbone via l'API du service de transfert de données BigQuery, puis interroger les données à l'aide de l'API BigQuery.

Utiliser l'API du service de transfert de données BigQuery

Pour appeler l'API du service de transfert de données BigQuery, vous pouvez utiliser les bibliothèques clientes fournies ou appeler directement l'API REST.

La documentation ci-dessous explique comment créer des configurations de transfert et des remplissages de l'empreinte carbone à l'aide de l'API REST. Toutefois, pour plus de commodité, vous pouvez préférer effectuer les appels d'API équivalents à l'aide de la bibliothèque cliente dans la langue de votre choix.

Créer une exportation via l'API REST

Appelez le point de terminaison transferConfigs.create de l'API du service de transfert de données BigQuery pour créer un transfert à l'aide de la charge utile suivante:

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

Remplacez :

  • NAME par le nom de votre configuration de transfert. (par exemple, "Rapport sur les émissions de carbone de l'entreprise")
  • BILLING_ACCOUNT_IDS par votre ID de compte de facturation. Cette valeur peut être une liste d'ID de compte de facturation séparés par une virgule. Exemple : XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX.
  • DATASET par l'ID de l'ensemble de données BigQuery de destination dans le projet en cours. Par exemple : company_carbon_report

Une fois la configuration de transfert créée, les données sur les émissions de carbone seront automatiquement exportées le 15 du mois pour tous les mois à venir. Pour exporter les données historiques, consultez la section ci-dessous.

Exécuter un remplissage des données historiques via l'API REST

Pour exporter l'historique des données sur l'empreinte carbone d'une configuration de transfert existante (voir ci-dessus), vous devez demander un remplissage de votre configuration de transfert.

Pour créer un remplissage, envoyez une requête POST au point de terminaison transferConfigs.startManualRuns, à l'aide de l'identifiant du transfert créé à l'étape précédente (par exemple, projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) et de la charge utile suivante:

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

Où :

  • START_TIME est un code temporel qui spécifie l'heure de début de la plage à remplir. Par exemple : 2021-02-15T00:00:00Z. Notez que le 15 février 2021 est la date la plus ancienne que vous pouvez spécifier ici, car elle contient les données de janvier 2021.
  • END_TIME est un horodatage qui spécifie l'heure de fin de la plage à remplir. Par exemple : 2022-09-15T00:00:00Z. Vous pouvez utiliser la date actuelle.

Interroger une exportation existante via l'API

Avant d'interroger l'API, rédigez une requête SQL qui renvoie les données souhaitées à partir de l'ensemble de données exporté. Vous pouvez tester la requête SQL dans la console BigQuery.

Après avoir configuré une exportation vers BigQuery, utilisez l'API BigQuery ou les bibliothèques BigQuery pour exécuter la requête.

Étape suivante