Exporta y lee tu huella de carbono con una API

La Huella de carbono no tiene una API pública dedicada. Sin embargo, puedes exportar tu huella de carbono a través de la API del Servicio de transferencia de datos de BigQuery y, luego, consultar los datos con la API de BigQuery.

Usa la API del Servicio de transferencia de datos de BigQuery

Para llamar a la API del Servicio de transferencia de datos de BigQuery, puedes usar las bibliotecas cliente proporcionadas o llamar a la API de REST directamente.

En la siguiente documentación, se describe cómo crear la configuración de transferencia y los reabastecimientos de la huella de carbono mediante la API de REST. Sin embargo, para tu comodidad, puedes preferir realizar las llamadas a la API equivalentes con la biblioteca cliente en el lenguaje que elijas.

Crea una exportación a través de la API de REST

Llama al extremo transferConfigs.create de la API del Servicio de transferencia de datos de BigQuery 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"
}

Reemplaza lo siguiente:

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

Una vez creada la configuración de transferencia, los datos de carbono se exportarán automáticamente el día 15 del mes para todos los meses futuros. Para exportar datos históricos, consulta los siguientes detalles.

Ejecuta un reabastecimiento de datos históricos a través de la API de REST

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

Para crear un reabastecimiento, envía una solicitud POST al extremo 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>"
  }
}

Aquí:

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

Consulta una exportación existente a través de la API

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

Después de configurar una exportación a BigQuery, usa la API de BigQuery o las bibliotecas de BigQuery para ejecutar la consulta.

Próximos pasos