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 pela API BigQuery Data Transfer Service e consultar os dados usando a API BigQuery.

Como usar a API do serviço de transferência de dados do BigQuery

Para chamar a API BigQuery Data Transfer Service, use as bibliotecas de cliente fornecidas ou chame a API REST diretamente.

A documentação abaixo descreve como criar backfills e configurações de transferência do Carbon Footprint usando a API REST. No entanto, para conveniência, talvez você prefira fazer as chamadas de API equivalentes usando a biblioteca de cliente no idioma de sua escolha.

Criar uma exportação usando a API REST

Chame o endpoint transferConfigs.create 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"
}

Substitua:

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

Depois que a configuração de transferência for criada, os dados de carbono serão exportados automaticamente no dia 15 de cada mês. Para exportar dados históricos, consulte abaixo.

Executar um preenchimento de dados históricos pela API REST

Para exportar os dados históricos de carbono de uma configuração de transferência atual (veja acima), faça o seguinte: será preciso solicitar um preenchimento na configuração de transferência.

Para criar um preenchimento, envie uma solicitação POST ao transferConfigs.startManualRuns endpoint, 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. A data mais próxima que você pode especificar aqui é 15 de fevereiro de 2021. já que contém 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 via 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