Package google.maps.airquality.v1

Índice

AirQuality

Serviços de qualidade do ar.

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

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

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 durante 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 para 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 de qualidade do ar. Existem vários índices no mundo que servem a diferentes finalidades e grupos 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 snake-case em vez de espaços. Exemplos: "uaqi", "fra_atmo".
display_name

string

Uma representação legível do nome do índice. Exemplo: "IQA (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 de índice. Exemplo: mais de 100 ou mais de 10.

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

Color

A cor usada para representar a pontuação numérica do IQA.
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 deve ser interpretado apenas no contexto de seu índice de qualidade do ar relacionado. Para índices não numéricos, este 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). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada.

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

CustomLocalAqi

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.

Campos
region_code

string

O país/região que exige o IQA personalizado. O valor deve ser fornecido com o código ISO 3166-1 alpha-2.
aqi

string

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

ExtraComputation

Recursos adicionais que podem ser ativados. Especificar cálculos extras faz com que os elementos e campos relevantes sejam retornados na resposta.

Enums
EXTRA_COMPUTATION_UNSPECIFIED O valor padrão. Ele será ignorado pelo servidor se for transmitido como um parâmetro.
LOCAL_AQI

Determina se deve incluir o IQA local (nacional) do local solicitado (país) na resposta.

Se especificado, a resposta conterá uma estrutura de dados 'air_quality_index' com todos os dados relevantes sobre o IQA local do local.
HEALTH_RECOMMENDATIONS

Determina se a resposta incluirá as orientações de saúde e as ações recomendadas para as condições atuais de IQA.

As recomendações são voltadas para a população em geral e seis populações em grupos de risco com mais sensibilidades a poluentes do que a população em geral.

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 devem ser 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 especificou o IQA global e o IQA local, até dois códigos poluentes podem ser retornados.

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

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

Se especificado, cada objeto 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 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 relacionados respiratórios e a asma.
heart_disease_population

string

Doenças cardíacas e do sistema circulatório.
athletes

string

Esportes e outras atividades intensas ao ar livre.
pregnant_women

string

Mulheres em todos os estágios da gravidez.
children

string

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

LookupCurrentConditionsRequest

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

Campos
location

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.
extra_computations[]

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados. Especificar cálculos extras faz com que os elementos e campos relevantes sejam retornados 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). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

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á.
universal_aqi

bool

Opcional. Se definido como verdadeiro, o IQA 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 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 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.
indexes[]

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[]

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

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.

LookupForecastRequest

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

Campos
location

LatLng

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

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados. Especificar cálculos extras faz com que os elementos e campos relevantes sejam retornados 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). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

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á.
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 subsequente.
Campo de união time_range. O intervalo de tempo dos dados necessários da previsão da qualidade do ar. O intervalo precisa ser pelo menos uma hora arredondada no futuro. A não especificação desse campo resultará em um erro INVALID_ARGUMENT. time_range pode ser apenas de um dos tipos a seguir:
date_time

Timestamp

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.

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 date_time está definido como 2023-01-03T11:05:49Z será arredondada para 2023-01-03T11:00:00Z.
period

Interval

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

bool

Opcional. Se definida como verdadeira, a IQA universal será incluída 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 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 de qualidade do ar.

Campos
hourly_forecasts[]

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

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

string

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

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.

Campos
date_time

Timestamp

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[]

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 universal_aqi estiver definido como verdadeiro.
  • IQA local. Será retornado se o cálculo extra LOCAL_AQI for especificado.
pollutants[]

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

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.

LookupHeatmapTileRequest

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

A estrutura está em conformidade com a chamada GET do servidor de bloco padrão, 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. Tipo de mapa de calor da qualidade do ar. Define o poluente que o mapa 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 0 representa 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 16 é o mundo inteiro em 65.536 blocos.

Valores permitidos: de 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 da 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 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

LatLng

Obrigatório. A latitude e a longitude para as quais a API busca dados históricos da qualidade do ar.
extra_computations[]

ExtraComputation

Opcional. Recursos adicionais que podem ser ativados. Especificar cálculos extras faz com que os elementos e campos relevantes sejam retornados 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). Essa paleta de cores é relevante apenas para UAQI. Outros IQAs têm uma paleta de cores predeterminada que não pode ser controlada.
custom_local_aqis[]

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á.
Campo de união time_range. O intervalo de tempo dos dados necessários sobre a qualidade do ar. A falha ao especificar qualquer campo relacionado ao intervalo de tempo resultará em um erro INVALID_ARGUMENT. time_range pode ser apenas um dos seguintes campos: 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: 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".
hours

int32

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

Interval

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

bool

Opcional. Se definido como verdadeiro, o IQA 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 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 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.
region_code

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

string

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

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.

Campos
date_time

Timestamp

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[]

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[]

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

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.

MapType

Tipo de mapa de calor da qualidade do ar. Define o poluente que o mapa representará graficamente.

Enums
MAP_TYPE_UNSPECIFIED O valor padrão. Ele será ignorado pelo servidor se for transmitido como um parâmetro.
UAQI_RED_GREEN Paleta vermelho e verde do Índice universal de qualidade do ar.
UAQI_INDIGO_PERSIAN Paleta índigo-persa do Índice Universal de Qualidade do Ar.
PM25_INDIGO_PERSIAN Paleta índigo-persa com índice PM2.5.
GBR_DEFRA Paleta de cores do índice diário de qualidade do ar (Reino Unido).
DEU_UBA Paleta de cores do Índice de qualidade do ar local da Alemanha.
CAN_EC Paleta de cores do Índice de Saúde da Qualidade do Ar canadense.
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". Confira uma lista de todos os códigos disponíveis aqui.
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 da IUPAC. Exemplo: "Dóxido de enxofre".

Para mais informações sobre a tabela de nomes da IUPAC, acesse https://iupac.org/what-we-do/periodic-table-of-elements/ (link em inglês).
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

Outras informações sobre o poluente.

AdditionalInfo

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

Campos
sources

string

Texto representando 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.

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