Retorna o histórico de qualidade do ar de um local específico para um determinado período.
Solicitação HTTP
POST https://airquality.googleapis.com/v1/history:lookup
O URL usa a sintaxe de transcodificação gRPC.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "pageSize": integer, "pageToken": string, "location": { object ( |
Campos | |
---|---|
pageSize |
Opcional. O número máximo de registros de informações por hora a serem retornados por página. O padrão é 72, e o valor máximo é 168 (sete dias de dados). |
pageToken |
Opcional. Um token de página recebido de uma chamada de histórico anterior. Ele é usado para recuperar a página subsequente. Observe que, ao fornecer um valor para esse parâmetro, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página (a chamada anterior). |
location |
Obrigatório. A latitude e a longitude para as quais a API busca dados históricos da qualidade do ar. |
extraComputations[] |
Opcional. Recursos adicionais que podem ser ativados. Especificar cálculos extras faz com que os elementos e campos relevantes sejam retornados na resposta. |
uaqiColorPalette |
Opcional. Determina a paleta de cores usada para os dados fornecidos pelo "Índice Universal de Qualidade do Ar" (UAQI). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada. |
customLocalAqis[] |
Opcional. Expressa uma relação de "país/região para IQA". Faz o pareamento de um país/região com um IQA desejado para que os dados de qualidade do ar necessários para esse país/região sejam exibidos de acordo com o IQA escolhido. Esse parâmetro pode ser usado para especificar um IQA não padrão para um determinado país, por exemplo, para receber o índice da EPA dos EUA em vez do padrão do Canadá. |
dateTime |
Um carimbo de data/hora para retornar dados históricos. O carimbo de data/hora é arredondado para a hora exata anterior. Observação: a consulta retornará dados por hora somente para o carimbo de data/hora solicitado (ou seja, um único elemento de informação por hora). Por exemplo, uma solicitação enviada em que o parâmetro dateTime está definido como 2023-01-03T11:05:49Z será arredondada para 2023-01-03T11:00:00Z. Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z". Observação:é possível usar |
hours |
Número de 1 a 720 que indica o período da solicitação. Por exemplo: um valor de 48 produzirá dados das últimas 48 horas. |
period |
Indica os períodos Observação:é possível usar |
universalAqi |
Opcional. Se definido como verdadeiro, o IQA universal será incluído no campo "indexes" da resposta. O valor padrão é true. |
languageCode |
Opcional. Permite que o cliente escolha o idioma da resposta. Se não for possível fornecer dados para esse idioma, a API usará a correspondência mais próxima. Os valores permitidos dependem do padrão IETF. O valor padrão é en. |
Corpo da resposta
Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:
Representação JSON |
---|
{
"hoursInfo": [
{
object ( |
Campos | |
---|---|
hoursInfo[] |
Opcional. Contém as informações sobre a qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for para 48 horas de histórico, haverá 48 elementos de informações por hora. |
regionCode |
Opcional. O código ISO_3166-1 alfa-2 do país/região correspondente ao local fornecido na solicitação. Esse campo poderá ser omitido da resposta se o local informado na solicitação estiver em um território disputado. |
nextPageToken |
Opcional. O token para recuperar a próxima página. |
Escopos de autorização
Requer o seguinte escopo OAuth:
https://www.googleapis.com/auth/cloud-platform
Para mais informações, consulte a Visão geral do OAuth 2.0.
HourInfo
Contém as informações sobre a qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for para 48 horas de histórico, haverá 48 elementos de informações por hora.
Representação JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
Campos | |
---|---|
dateTime |
Um carimbo de data/hora arredondado para baixo indicando a hora em que os dados se referem no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Por exemplo: "2014-10-02T15:00:00Z". |
indexes[] |
Com base nos parâmetros de solicitação, essa lista incluirá (até) dois índices de qualidade do ar:
|
pollutants[] |
Uma lista dos poluentes afetando o local especificado na solicitação. Observação: esse campo será retornado somente para solicitações que especificaram um ou mais dos seguintes cálculos extras: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations |
Orientações de saúde e ações recomendadas relacionadas às condições de qualidade do ar informadas. As recomendações são adaptadas de maneira diferente para populações em risco, grupos com maior sensibilidade a poluentes e a população em geral. |