Exportar y leer tu huella de carbono con una API

Huella de carbono no tiene una API pública específica. Sin embargo, puede exportar su huella de carbono a través de la API de BigQuery Data Transfer Service y, a continuación, consultar los datos mediante la API de BigQuery.

Usar la API de BigQuery Data Transfer Service

Para llamar a la API BigQuery Data Transfer Service, puedes usar las bibliotecas de cliente proporcionadas o llamar directamente a la API REST.

En la documentación que se incluye a continuación se describe cómo crear configuraciones de transferencia de huella de carbono y rellenar datos históricos con la API REST. Sin embargo, para mayor comodidad, puedes hacer las llamadas a la API equivalentes mediante la biblioteca de cliente en el lenguaje que elijas.

Crear una exportación mediante la API REST

Llama al endpoint transferConfigs.create de la API BigQuery Data Transfer Service para crear una transferencia con la siguiente carga útil:

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

Sustituye:

  • NAME por el nombre de la configuración de transferencia. Por ejemplo: "Informe de emisiones de carbono de la empresa"
  • BILLING_ACCOUNT_IDS con el ID de tu cuenta de facturación. Este valor puede ser una lista de IDs de cuentas de facturación separados por comas. Por ejemplo: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET con el ID del conjunto de datos de BigQuery de destino en el proyecto actual. Por ejemplo: company_carbon_report

Una vez que se haya creado la configuración de transferencia, los datos de carbono se exportarán automáticamente el día 15 de cada mes. Para exportar el historial de datos, consulta la información que se indica más abajo.

Ejecutar un relleno de datos históricos mediante la API REST

Para exportar datos históricos de emisiones de carbono de una configuración de transferencia (consulta la sección anterior), debes solicitar un relleno retroactivo en la configuración de transferencia.

Para crear un relleno, envía una solicitud POST al endpoint transferConfigs.startManualRuns con el identificador de la transferencia creada en el paso anterior (por ejemplo, projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) y la siguiente carga útil:

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

Donde:

  • START_TIME es una marca de tiempo que especifica la hora de inicio del intervalo que se va a rellenar. Por ejemplo: 2021-02-15T00:00:00Z. Ten en cuenta que el 15 de febrero del 2021 es la fecha más antigua que puedes especificar aquí, ya que contiene los datos de enero del 2021.
  • END_TIME es una marca de tiempo que especifica la hora de finalización del intervalo que se va a rellenar. Por ejemplo: 2022-09-15T00:00:00Z. Puedes usar la fecha actual.

Consultar una exportación mediante la API

Antes de consultar la API, escribe una consulta de SQL que devuelva los datos que quieras del conjunto de datos exportado. Puedes probar la consulta de SQL en la consola de BigQuery.

Una vez que hayas configurado una exportación a BigQuery, usa la API de BigQuery o las bibliotecas de BigQuery para ejecutar la consulta.

Siguientes pasos