Exportar e ler sua pegada de carbono usando uma API

A Pegada de carbono não tem uma API pública dedicada. No entanto, é possível exportar sua pegada de carbono por meio da API do serviço de transferência de dados do BigQuery e, em seguida, consultar os dados usando a API BigQuery.

Como usar a API Data Transfer Service do BigQuery

Para chamar a API do serviço de transferência de dados do BigQuery, use as bibliotecas de cliente fornecidas ou chame a API REST diretamente.

A documentação abaixo descreve como criar configurações de transferência e preenchimentos da Pegada de carbono usando a API REST. No entanto, por conveniência, é recomendável fazer as chamadas de API equivalentes usando a biblioteca de cliente na sua linguagem preferida.

Criar uma exportação usando a API REST

Chame o endpoint transferConfigs.create da API do serviço de transferência de dados do BigQuery para criar uma transferência usando o payload a seguir:

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

Substitua:

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

Depois que a configuração de transferência é criada, os dados de carbono são exportados automaticamente no dia 15 de todos os meses futuros. Para exportar dados históricos, confira abaixo.

Executar um preenchimento de dados históricos pela API REST

Para exportar dados históricos de carbono de uma configuração de transferência atual (confira acima), solicite um preenchimento na sua configuração de transferência.

Para criar um preenchimento, envie uma solicitação POST para o endpoint transferConfigs.startManualRuns, usando o identificador da transferência criada na etapa 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>"
  }
}

Em que:

  • START_TIME é um carimbo de data/hora que especifica o horário de início do intervalo a ser preenchido. Por exemplo: 2021-02-15T00:00:00Z. 15 de fevereiro de 2021 é a data mais antiga que pode ser especificada aqui, já que contém os dados de janeiro de 2021.
  • END_TIME é um carimbo de data/hora que especifica o horário de término do intervalo a ser preenchido. Por exemplo: 2022-09-15T00:00:00Z. Você pode usar a data atual.

Consultar uma exportação atual usando a API

Antes de consultar a API, escreva uma consulta SQL que retorne os dados desejados do conjunto de dados exportado. É possível testar a consulta SQL no console do BigQuery.

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

A seguir