Method: currentConditions.lookup

O endpoint das Condições atuais fornece informações por hora sobre a qualidade do ar em mais de 100 países, com uma resolução de até 500 x 500 metros. Inclui mais de 70 índices locais, além de categorias e índices globais de qualidade do ar.

Solicitação HTTP

POST https://airquality.googleapis.com/v1/currentConditions: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
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "universalAqi": boolean,
  "languageCode": string
}
Campos
location

object (LatLng)

Obrigatório. A longitude e a latitude a partir das quais a API busca dados sobre as condições atuais da qualidade do ar.

extraComputations[]

enum (ExtraComputation)

Opcional. Outros recursos que podem ser ativados. Especificar computações extras faz com que os elementos e campos relevantes sejam retornados na resposta.

uaqiColorPalette

enum (ColorPalette)

Opcional. Determina a paleta de cores usada para os dados fornecidos pelo "Índice Universal de Qualidade do Ar" (UAQI, na sigla em inglês). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada.

customLocalAqis[]

object (CustomLocalAqi)

Opcional. Expressa uma relação de "país/região para IQA". Associa 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 para o Canadá em vez do índice padrão.

universalAqi

boolean

Opcional. Se definida como verdadeira, a AQI universal será incluída no campo "índices" da resposta. O valor padrão é true.

languageCode

string

Opcional. Permite que o cliente escolha o idioma da resposta. Se não for possível fornecer os dados para um 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
{
  "dateTime": string,
  "regionCode": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Campos
dateTime

string (Timestamp format)

Um carimbo de data/hora arredondado para baixo no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Por exemplo: "2014-10-02T15:00:00Z".

regionCode

string

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 fornecido na solicitação estiver em um território disputado.

indexes[]

object (AirQualityIndex)

Com base nos parâmetros da solicitação, essa lista incluirá (até) dois índices de qualidade do ar:

  • IQA universal. Será retornado se o booleano universalAqi estiver definido como verdadeiro.
  • IQA local. Será retornado se o cálculo extra LOCAL_AQI for especificado.
pollutants[]

object (Pollutant)

Uma lista dos poluentes afetando o local especificado na solicitação. Observação: este campo será retornado somente para solicitações que especificarem um ou mais dos seguintes cálculos extras: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.

healthRecommendations

object (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 forma diferente para populações de risco, grupos com maior sensibilidade a poluentes e a população em geral.

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.