Method: forecast.lookup

Retorna a previsão da qualidade do ar para um local específico durante um determinado período.

Solicitação HTTP

POST https://airquality.googleapis.com/v1/forecast: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)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Campos
location

object (LatLng)

Obrigatório. A latitude e a longitude para as quais a API busca dados de qualidade do ar.
extraComputations[]

enum (ExtraComputation)

Opcional. Recursos adicionais que podem ser ativados. Especificar cálculos 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). 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". 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á.
pageSize

integer

Opcional. O número máximo de registros de informações por hora a serem retornados por página (padrão = 24).
pageToken

string

Opcional. Um token de página recebido de uma chamada de previsão anterior. Ele é usado para recuperar a página subsequente.
dateTime

string (Timestamp format)

Carimbo de data/hora para o qual retornar os dados de um ponto específico no tempo. O carimbo de data/hora é arredondado para a hora exata anterior.

Isso 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.

Observação:é possível usar dateTime ou startTime e endTime em uma solicitação.
period

object (Interval)

Indica os períodos startTime e endTime para receber os dados de previsão. O endTime é inclusivo. O carimbo de data/hora é arredondado para a hora exata anterior.

Observação:é possível usar dateTime ou startTime e endTime em uma solicitação.
universalAqi

boolean

Opcional. Se definida como verdadeira, a IQA universal será incluída no campo "indexes" da resposta (padrão = true).
languageCode

string

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 (padrão = 'en').

Corpo da resposta

O objeto de resposta da API de previsão de qualidade do ar.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Campos
hourlyForecasts[]

object (HourlyForecast)

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 previsão, haverá 48 elementos de previsões por hora.
regionCode

string

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

string

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.

HourlyForecast

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 previsão, haverá 48 elementos de previsões por hora.

Representação JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Campos
dateTime

string (Timestamp format)

Um carimbo de data/hora arredondado para baixo indicando a hora (hora) a que os dados se referem no formato RFC3339 UTC "Zulu". Por exemplo: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

Com base nos parâmetros de 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: 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

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