Package google.maps.airquality.v1

Índice

AirQuality

Serviços de qualidade do ar.

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

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

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

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

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

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

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

Retorna uma matriz de bytes contendo os dados da imagem PNG do bloco.

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

rpc LookupHistory(LookupHistoryRequest) returns (LookupHistoryResponse)

Retorna o histórico de qualidade do ar de um local específico em um determinado período.

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.

AirQualityIndex

O objeto básico para representar diferentes métricas de qualidade do ar. Quando reunidas, essas métricas fornecem um resumo das condições atuais da qualidade do ar. Há vários índices no mundo com finalidades e grupos diferentes interessados em medir diferentes aspectos da qualidade do ar.

Campos
code

string

O código do índice. Esse campo representa o índice para fins de programação usando letras minúsculas em vez de espaços. Exemplos: "uaqi", "fra_atmo".
display_name

string

Uma representação legível por humanos do nome do índice. Exemplo: "AQI (EUA)"
aqi_display

string

Representação textual da pontuação numérica do índice, que pode incluir símbolos de prefixo ou sufixo, que geralmente representa a pior pontuação do índice. Exemplo: >100 ou 10+.

Observação: esse campo deve ser usado quando você quiser mostrar a pontuação do índice. Para índices não numéricos, esse campo fica vazio.
color

Color

A cor usada para representar a pontuação numérica do AQI.
category

string

Classificação textual da interpretação da pontuação numérica do índice. Por exemplo: "Qualidade do ar excelente".
dominant_pollutant

string

O símbolo químico do poluente dominante. Por exemplo: "CO".
aqi

int32

A pontuação numérica do índice. Exemplos: 10, 100.

O valor não é normalizado e só pode ser interpretado no contexto do índice de qualidade do ar relacionado. Para índices não numéricos, esse campo não será retornado.

Observação: esse campo deve ser usado para cálculos, exibição de gráficos etc. Para mostrar a pontuação do índice, use o campo de exibição do IQA.

ColorPalette

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 a UAQI. Outras AQIs têm uma paleta de cores predeterminada que não pode ser controlada.

Enums
COLOR_PALETTE_UNSPECIFIED O valor padrão. Será ignorado se transmitido como um parâmetro.
RED_GREEN Determina se é preciso usar uma paleta vermelha/verde.
INDIGO_PERSIAN_DARK Determina se uma paleta índigo/persa (tema escuro) será usada.
INDIGO_PERSIAN_LIGHT Determina se uma paleta índigo/persa (tema claro) será usada.

CustomLocalAqi

Expressa uma relação "país/região com AQI". Combina 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 mostrados de acordo com o IQA escolhido.

Campos
region_code

string

O país/região que exige o AQI personalizado. O valor precisa ser fornecido usando o código ISO 3166-1 Alfa-2.
aqi

string

O IQA a ser associado ao país/região. O valor precisa ser um código de índice válido.

ExtraComputation

Recursos adicionais que podem ser ativados opcionalmente. Especificar cálculos extras vai resultar na devolução dos elementos e campos relevantes na resposta.

Enums
EXTRA_COMPUTATION_UNSPECIFIED O valor padrão. O servidor vai ignorá-lo se ele for transmitido como um parâmetro.
LOCAL_AQI

Determina se a AQI local (nacional) do local (país) solicitado será incluída na resposta.

Se especificado, a resposta vai conter uma estrutura de dados "air_quality_index" com todos os dados relevantes sobre o AQI local do local.
HEALTH_RECOMMENDATIONS

Determina se a resposta vai incluir as recomendações de saúde e as ações recomendadas para as condições atuais do AQI.

As recomendações são adaptadas para a população em geral e seis grupos de risco com maior sensibilidade a poluentes.

Se especificado, o campo health_recommendations será preenchido na resposta quando os dados relevantes estiverem disponíveis.
POLLUTANT_ADDITIONAL_INFO

Determina se as informações adicionais de cada poluente serão incluídas na resposta.

Se especificado, cada objeto de índice de qualidade do ar contido na resposta do campo "indexes" vai incluir um campo additional_info quando os dados estiverem disponíveis.
DOMINANT_POLLUTANT_CONCENTRATION

Determina se a resposta inclui as concentrações dos poluentes dominantes medidas de acordo com índices globais e/ou locais.

Se a solicitação especificar o AQI global e o AQI local, até dois códigos de poluente podem ser retornados.

Se especificado, o objeto de poluente dominante contido na lista "poluentes" vai incluir um campo concentration quando os dados estiverem disponíveis.
POLLUTANT_CONCENTRATION

Determina se a resposta vai incluir as concentrações de todos os poluentes com medições disponíveis de acordo com os índices globais e/ou locais.

Se especificado, cada objeto de poluente contido no campo "poluentes" na resposta vai incluir um campo concentration quando os dados estiverem disponíveis.

HealthRecommendations

Recomendações de saúde para diferentes grupos populacionais em um formato de texto livre. As recomendações são derivadas das condições de qualidade do ar associadas.

Campos
general_population

string

Nenhuma sensibilidade específica.
elderly

string

Aposentados e pessoas mais velhas do que a população em geral.
lung_disease_population

string

Problemas respiratórios e asma.
heart_disease_population

string

Doenças do coração e do sistema circulatório.
athletes

string

Esportes e outras atividades extenuantes ao ar livre.
pregnant_women

string

Mulheres em todas as fases da gravidez.
children

string

Populações mais jovens, incluindo crianças, crianças pequenas e bebês.

LookupCurrentConditionsRequest

A definição de solicitação das condições atuais da qualidade do ar.

Campos
location

LatLng

Obrigatório. A longitude e a latitude em que a API procura dados sobre as condições atuais da qualidade do ar.
extra_computations[]

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados opcionalmente. Especificar cálculos extras vai resultar na devolução dos elementos e campos relevantes na resposta.
uaqi_color_palette

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 a UAQI. Outras AQIs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expressa uma relação "país/região com AQI". Combina 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 mostrados 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 US EPA para o Canadá em vez do índice padrão.
universal_aqi

bool

Opcional. Se definido como "true", o AQI universal será incluído no campo "indexes" da resposta. O valor padrão é true.
language_code

string

Opcional. Permite que o cliente escolha o idioma da resposta. Se não for possível fornecer dados para esse idioma, a API vai usar a correspondência mais próxima. Os valores permitidos dependem do padrão IETF. O valor padrão é "en".

LookupCurrentConditionsResponse

Campos
date_time

Timestamp

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".
region_code

string

O código ISO_3166-1 alpha-2 do país/região correspondente ao local informado na solicitação. Esse campo pode ser omitido da resposta se o local informado na solicitação estiver em um território disputado.
indexes[]

AirQualityIndex

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

  • IQA universal. Será retornado se o booleano universalAqi for definido como verdadeiro.
  • IQA local. Será retornado se a computação extra LOCAL_AQI for especificada.
pollutants[]

Pollutant

Uma lista de poluentes que afetam o local especificado na solicitação. Observação: esse campo só será retornado para solicitações que especificaram uma ou mais das seguintes computações extras: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Conselhos de saúde e ações recomendadas relacionadas às condições de qualidade do ar informadas. As recomendações são personalizadas de forma diferente para populações em risco, grupos com maior sensibilidade a poluentes e a população em geral.

LookupForecastRequest

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

Campos
location

LatLng

Obrigatório. A latitude e a longitude para que a API procura dados de qualidade do ar.
extra_computations[]

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados opcionalmente. Especificar cálculos extras vai resultar na devolução dos elementos e campos relevantes na resposta.
uaqi_color_palette

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 a UAQI. Outras AQIs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expressa uma relação "país/região com AQI". Combina 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 mostrados 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 US EPA para o Canadá em vez do índice padrão.
page_size

int32

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

string

Opcional. Um token de página recebido de uma chamada de previsão anterior. Ele é usado para recuperar a página seguinte.
Campo de união time_range. O período dos dados de previsão de qualidade do ar necessários. O intervalo precisa ser de pelo menos uma hora arredonda para o futuro. Se esse campo não for especificado, vai ocorrer um erro INVALID_ARGUMENT. time_range pode ser apenas de um dos tipos a seguir:
date_time

Timestamp

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

Observação: isso vai retornar dados por hora apenas para o carimbo de data/hora solicitado (ou seja, um único elemento de informações por hora). Por exemplo, uma solicitação enviada em que o parâmetro date_time está definido como 2023-01-03T11:05:49Z será arredondado para 2023-01-03T11:00:00Z.
period

Interval

Indica o período de início e término para receber os dados de previsão. O carimbo de data/hora é arredondado para a hora exata anterior.
universal_aqi

bool

Opcional. Se definido como "true", o AQI universal será incluído no campo "indexes" da resposta (padrão = "true").
language_code

string

Opcional. Permite que o cliente escolha o idioma da resposta. Se não for possível fornecer dados para esse idioma, a API vai usar a correspondência mais próxima. Os valores permitidos dependem do padrão IETF (padrão = "en").

LookupForecastResponse

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

Campos
hourly_forecasts[]

HourlyForecast

Opcional. Contém as informações de qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for de 48 horas de previsão, haverá 48 elementos de previsões por hora.
region_code

string

Opcional. O código ISO_3166-1 alfa-2 do país/região correspondente ao local informado na solicitação. Esse campo pode ser omitido da resposta se o local informado na solicitação estiver em um território disputado.
next_page_token

string

Opcional. O token para recuperar a próxima página.

HourlyForecast

Contém as informações de qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for de 48 horas de previsão, haverá 48 elementos de previsões por hora.

Campos
date_time

Timestamp

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

AirQualityIndex

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

  • IQA universal. Será retornado se o booleano universal_aqi for definido como verdadeiro.
  • IQA local. Será retornado se a computação extra LOCAL_AQI for especificada.
pollutants[]

Pollutant

Uma lista de poluentes que afetam o local especificado na solicitação.

Observação: esse campo só será retornado para solicitações que especificaram uma ou mais das seguintes computações extras: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Conselhos de saúde e ações recomendadas relacionadas às condições de qualidade do ar informadas. As recomendações são personalizadas de forma diferente para populações em risco, grupos com maior sensibilidade a poluentes e a população em geral.

LookupHeatmapTileRequest

Uma solicitação de bloco de mapa de calor.

A estrutura obedece à chamada GET padrão do servidor de blocos, ou seja, https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}

Exemplo: https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1

Campos
map_type

MapType

Obrigatório. O tipo de mapa de calor da qualidade do ar. Define o poluente que o mapa vai representar graficamente.

Allowed values:
- UAQI_RED_GREEN (UAQI, red-green palette)
- UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette)
- PM25_INDIGO_PERSIAN
- GBR_DEFRA
- DEU_UBA
- CAN_EC
- FRA_ATMO
- US_AQI
zoom

int32

Obrigatório. O nível de zoom do mapa. Define o tamanho do conteúdo de um mapa em uma visualização de mapa.

O nível de zoom 0 é o mundo inteiro em um único bloco. O nível de zoom 1 é o mundo inteiro em quatro blocos. O nível de zoom 2 é o mundo inteiro em 16 blocos. O nível de zoom 16 é o mundo inteiro em 65.536 blocos.

Valores permitidos: 0 a 16
x

int32

Obrigatório. Define o ponto leste-oeste no bloco solicitado.
y

int32

Obrigatório. Define o ponto norte-sul no bloco solicitado.

LookupHistoryRequest

O objeto de solicitação da API de histórico de qualidade do ar.

Campos
page_size

int32

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).
page_token

string

Opcional. Um token de página recebido de uma chamada de histórico anterior. Ele é usado para recuperar a página seguinte.

Ao fornecer um valor para esse parâmetro, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página (a chamada anterior).
location

LatLng

Obrigatório. A latitude e a longitude em que a API procura dados históricos de qualidade do ar.
extra_computations[]

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados opcionalmente. Especificar cálculos extras vai resultar na devolução dos elementos e campos relevantes na resposta.
uaqi_color_palette

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 a UAQI. Outras AQIs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expressa uma relação "país/região com AQI". Combina 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 mostrados 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 US EPA para o Canadá em vez do índice padrão.
Campo de união time_range. O período dos dados de qualidade do ar necessários. A falha em especificar qualquer campo relacionado ao período vai resultar em um erro INVALID_ARGUMENT. O time_range só pode ser uma das seguintes opções: time_range só pode ser uma das seguintes opções:
date_time

Timestamp

Um carimbo de data/hora para retornar dados históricos. O carimbo de data/hora é arredondado para a hora exata anterior.

Observação: isso vai retornar dados por hora apenas para o carimbo de data/hora solicitado (ou seja, um único elemento de informações por hora). Por exemplo, uma solicitação enviada em que o parâmetro dateTime está definido como 2023-01-03T11:05:49Z será arredondado 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".
hours

int32

Número de 1 a 720 que indica o intervalo de horas da solicitação. Por exemplo: um valor de 48 vai gerar dados das últimas 48 horas.
period

Interval

Indica o período de início e término para receber os dados históricos. O carimbo de data/hora é arredondado para a hora exata anterior.
universal_aqi

bool

Opcional. Se definido como "true", o AQI universal será incluído no campo "indexes" da resposta. O valor padrão é true.
language_code

string

Opcional. Permite que o cliente escolha o idioma da resposta. Se não for possível fornecer dados para esse idioma, a API vai usar a correspondência mais próxima. Os valores permitidos dependem do padrão IETF. O valor padrão é "en".

LookupHistoryResponse

Campos
hours_info[]

HourInfo

Opcional. Contém as informações de qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for de 48 horas de histórico, haverá 48 elementos de informações por hora.
region_code

string

Opcional. O código ISO_3166-1 alfa-2 do país/região correspondente ao local informado na solicitação. Esse campo pode ser omitido da resposta se o local informado na solicitação estiver em um território disputado.
next_page_token

string

Opcional. O token para recuperar a próxima página.

HourInfo

Contém as informações de qualidade do ar para cada hora no intervalo solicitado. Por exemplo, se a solicitação for de 48 horas de histórico, haverá 48 elementos de informações por hora.

Campos
date_time

Timestamp

Um carimbo de data/hora arredondado para baixo que indica o horário a 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[]

AirQualityIndex

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

  • IQA universal. Será retornado se o booleano universalAqi for definido como verdadeiro.
  • IQA local. Será retornado se a computação extra LOCAL_AQI for especificada.
pollutants[]

Pollutant

Uma lista de poluentes que afetam o local especificado na solicitação. Observação: esse campo só será retornado para solicitações que especificaram uma ou mais das seguintes computações extras: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Conselhos de saúde e ações recomendadas relacionadas às condições de qualidade do ar informadas. As recomendações são personalizadas de forma diferente para populações em risco, grupos com maior sensibilidade a poluentes e a população em geral.

MapType

O tipo de mapa de calor da qualidade do ar. Define o poluente que o mapa vai representar graficamente.

Enums
MAP_TYPE_UNSPECIFIED O valor padrão. O servidor vai ignorá-lo se ele for transmitido como um parâmetro.
UAQI_RED_GREEN Paleta vermelha-verde do Índice universal de qualidade do ar.
UAQI_INDIGO_PERSIAN Paleta de cores índigo-persa do Índice Universal de Qualidade do Ar.
PM25_INDIGO_PERSIAN Índice de PM2,5 com paleta índigo-persa.
GBR_DEFRA Paleta de cores do Índice Diário de Qualidade do Ar (Reino Unido).
DEU_UBA Paleta de cores do Índice local de qualidade do ar da Alemanha.
CAN_EC Paleta de cores do Índice de Saúde referente à Qualidade do Ar do Canadá.
FRA_ATMO Paleta de cores do Índice de Qualidade do Ar da França.
US_AQI Paleta de cores do Índice de Qualidade do Ar dos EUA.

Poluente

Dados sobre um poluente da qualidade do ar.

Campos
code

string

O nome do código do poluente (por exemplo, "so2"). Para conferir uma lista de códigos de poluentes aceitos, consulte Poluentes informados.
display_name

string

O nome de exibição do poluente. Por exemplo: "NOx".
full_name

string

O nome completo do poluente. Para compostos químicos, esse é o nome IUPAC. Exemplo: "Dióxido de enxofre".

Para mais informações sobre a tabela de nomes da IUPAC, consulte https://iupac.org/what-we-do/periodic-table-of-elements/.
concentration

Concentration

O nível de concentração do poluente medido por uma das unidades padrão de medida de poluição do ar.
additional_info

AdditionalInfo

Informações adicionais sobre o poluente.

AdditionalInfo

As fontes de emissão e os efeitos na saúde de um determinado poluente.

Campos
sources

string

Texto que representa as principais fontes de emissão do poluente.
effects

string

Texto que representa os principais efeitos do poluente na saúde.

Concentração

A concentração de um determinado poluente no ar.

Campos
units

Unit

Unidades para medir essa concentração de poluentes.
value

float

Valor da concentração de poluentes.

Unidade

Define a unidade usada para medir a concentração do poluente. Para determinar a unidade de concentração padrão de um determinado poluente, consulte a tabela em Poluentes informados.

Enums
UNIT_UNSPECIFIED Unidade de concentração não especificada.
PARTS_PER_BILLION A unidade de concentração ppb (partes por bilhão).
MICROGRAMS_PER_CUBIC_METER A unidade de concentração "µg/m^3" (microgramas por metro cúbico).