Exporte e leia a sua pegada de carbono através de uma API

A pegada de carbono não tem uma API pública dedicada. No entanto, pode exportar a sua pegada de carbono através da API BigQuery Data Transfer Service e, em seguida, consultar os dados através da API BigQuery.

Usar a API BigQuery Data Transfer Service

Para chamar a API do Serviço de transferência de dados do BigQuery, pode usar as bibliotecas cliente fornecidas ou chamar diretamente a API REST.

A documentação abaixo descreve como criar configurações de transferência e preenchimentos de dados da pegada de carbono através da API REST. No entanto, para maior comodidade, pode preferir fazer as chamadas API equivalentes através da biblioteca cliente no seu idioma de escolha.

Crie uma exportação através da API REST

Chame o transferConfigs.create endpoint da API BigQuery Data Transfer Service para criar uma transferência, usando o seguinte payload:

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

Substituir:

  • NAME com o nome da configuração de transferência. Por exemplo: "Relatório de carbono da empresa"
  • BILLING_ACCOUNT_IDS com o ID da conta de faturação. Este valor pode ser uma lista de IDs de contas de faturação separados por vírgulas. Por exemplo: XXXXXX-XXXXXX-XXXXXX,XXXXXX-XXXXXX-XXXXXX
  • DATASET com o ID do conjunto de dados do BigQuery de destino no projeto atual. Por exemplo: company_carbon_report

Depois de criar a configuração de transferência, os dados de carbono são exportados automaticamente no dia 15 de cada mês para todos os meses futuros. Para exportar dados do histórico, consulte as instruções abaixo.

Execute um repreenchimento de dados históricos através da API REST

Para exportar dados de carbono do histórico para uma configuração de transferência existente (consulte acima), tem de pedir um preenchimento retroativo na configuração de transferência.

Para criar um preenchimento, envie um pedido POST para o ponto final transferConfigs.startManualRuns, usando o identificador da transferência criada no passo anterior (por exemplo, projects/0000000000000/locations/us/transferConfigs/00000000-0000-0000-0000-000000000000) e o seguinte payload:

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

Onde:

  • START_TIME é uma indicação de tempo que especifica a hora de início do intervalo a preencher. Por exemplo: 2021-02-15T00:00:00Z. Tenha em atenção que 15 de fevereiro de 2021 é a data mais antiga que pode especificar aqui, uma vez que contém os dados de janeiro de 2021.
  • END_TIME é uma data/hora que especifica a hora de fim do intervalo a preencher. Por exemplo: 2022-09-15T00:00:00Z. Pode usar a data atual.

Consultar uma exportação existente através da API

Antes de consultar a API, escreva uma consulta SQL que devolva os dados pretendidos do conjunto de dados exportado. Pode testar a consulta SQL na consola do BigQuery.

Depois de configurar uma exportação para o BigQuery, use a API BigQuery ou as bibliotecas do BigQuery para executar a consulta.

O que se segue?