Package google.maps.airquality.v1

Índice

AirQuality

Servicios de calidad del aire.

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

El extremo Condiciones actuales proporciona información por hora sobre la calidad del aire en más de 100 países, con una resolución de hasta 500 x 500 metros. Incluye más de 70 índices locales y categorías y el índice de calidad del aire global.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta la Descripción general de OAuth 2.0.
LookupForecast

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

Muestra el pronóstico de la calidad del aire de una ubicación específica durante un período determinado.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta la Descripción general de OAuth 2.0.
LookupHeatmapTile

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

Muestra un array de bytes que contiene los datos de la imagen PNG de mosaico.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta la Descripción general de OAuth 2.0.
LookupHistory

rpc LookupHistory(LookupHistoryRequest) returns (LookupHistoryResponse)

Muestra el historial de calidad del aire de una ubicación específica durante un período determinado.

Alcances de autorización

Requiere el siguiente alcance de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta la Descripción general de OAuth 2.0.

AirQualityIndex

Es el objeto básico para representar diferentes métricas de calidad del aire. Cuando se combinan, estas métricas proporcionan un panorama sobre las condiciones actuales de calidad del aire. En el mundo, existen múltiples índices que tienen distintos propósitos y grupos interesados en medir distintos aspectos de la calidad del aire.

Campos
code

string

El código del índice. Este campo representa el índice para fines de programación mediante el uso de Snake case en lugar de espacios. Ejemplos: “uaqi”, “fra_atmo”.
display_name

string

Es una representación legible del nombre del índice. Ejemplo: "ICA (EE.UU.)"
aqi_display

string

Representación textual de la puntuación numérica del índice, que puede incluir símbolos de prefijo o sufijo, que generalmente representa la peor puntuación del índice. Ejemplo: >100 o 10+.

Nota: Este campo debe usarse cuando quieres mostrar la puntuación del índice. En el caso de los índices no numéricos, este campo está vacío.
color

Color

El color que se usa para representar la puntuación numérica del ICA.
category

string

Clasificación textual de la interpretación de la puntuación numérica del índice Por ejemplo: “Calidad del aire excelente”.
dominant_pollutant

string

El símbolo químico del contaminante dominante. Por ejemplo: “CO”.
aqi

int32

La puntuación numérica del índice. Ejemplos: 10, 100.

El valor no está normalizado y solo debe interpretarse en el contexto del índice de calidad del aire relacionado. En el caso de los índices no numéricos, no se mostrará este campo.

Nota: Este campo debe usarse para cálculos, mostrar gráficos, etc. Para mostrar la puntuación del índice, debes usar el campo de visualización del ICA.

ColorPalette

Determina la paleta de colores que se utiliza para los datos que proporciona el "Índice Universal de Calidad del Aire" (UAQI). Esta paleta de colores es relevante solo para UAQI; otros AQI tienen una paleta de colores predeterminada que no se puede controlar.

Enumeradores
COLOR_PALETTE_UNSPECIFIED Es el valor predeterminado. Se ignora si se pasa como parámetro.
RED_GREEN Determina si se usará una paleta de rojo a verde.
INDIGO_PERSIAN_DARK Determina si se debe usar una paleta índigo/persiana (tema oscuro).
INDIGO_PERSIAN_LIGHT Determina si se debe usar una paleta índigo/persiana (tema claro).

CustomLocalAqi

Expresa una relación de “país/región con el índice de calidad de aire”. Vincula un país o una región con un ICA deseado para que se muestren los datos de la calidad del aire necesarios para ese país o región según el ICA elegido.

Campos
region_code

string

Es el país o la región que requiere el ICA personalizado. El valor se debe proporcionar con el código ISO 3166-1 alpha-2.
aqi

string

El ICA con el que se asociará el país o la región. El valor debe ser un código de índice válido.

ExtraComputation

Funciones adicionales que se pueden habilitar de forma opcional Si especificas cálculos adicionales, se mostrarán los elementos y campos relevantes en la respuesta.

Enumeradores
EXTRA_COMPUTATION_UNSPECIFIED Es el valor predeterminado. El servidor los ignora si se pasa como parámetro.
LOCAL_AQI

Determina si se debe incluir el ICA local (nacional) de la ubicación (país) solicitada en la respuesta.

Si se especifica, la respuesta contendrá una estructura de datos “air_quality_index” con todos los datos relevantes sobre el ICA local de la ubicación.
HEALTH_RECOMMENDATIONS

Determina si la respuesta incluirá consejos de salud y acciones recomendadas para las condiciones actuales del ICA.

Las recomendaciones se adaptaron para la población general y seis poblaciones en riesgo con mayor sensibilidad a los contaminantes que la población general.

Si se especifica, el campo health_recommendations se propagará en la respuesta cuando los datos relevantes estén disponibles.
POLLUTANT_ADDITIONAL_INFO

Determina si se debe incluir en la respuesta la información adicional de cada contaminante.

Si se especifica, cada objeto del índice de calidad del aire incluido en la respuesta del campo "índices" incluirá un campo additional_info cuando los datos estén disponibles.
DOMINANT_POLLUTANT_CONCENTRATION

Determina si la respuesta incluiría las concentraciones de los contaminantes dominantes medidas de acuerdo con los índices globales o locales.

Si en la solicitud se especifica tanto el ICA global como el ICA local, es posible que se muestren hasta dos códigos de contaminantes.

Si se especifica, el objeto contaminante dominante que se incluye en la lista "contaminantes" incluirá un campo concentration cuando los datos estén disponibles.
POLLUTANT_CONCENTRATION

Determina si la respuesta incluiría las concentraciones de todos los contaminantes con mediciones disponibles de acuerdo con los índices globales o locales.

Si se especifica, cada objeto contaminante contenido en el campo “pollutants” de la respuesta incluirá un campo concentration cuando los datos estén disponibles.

HealthRecommendations

Recomendaciones de salud para diferentes grupos de población en formato de texto libre. Las recomendaciones derivan de las condiciones de calidad del aire asociadas.

Campos
general_population

string

No hay sensibilidades específicas.
elderly

string

Personas jubiladas y personas mayores que la población general.
lung_disease_population

string

Los problemas respiratorios y el asma se ven afectados.
heart_disease_population

string

Enfermedades cardíacas y del sistema circulatorio.
athletes

string

Deportes y otras actividades extenuantes al aire libre
pregnant_women

string

Mujeres en todas las etapas del embarazo.
children

string

Poblaciones más jóvenes, niños, niños pequeños y bebés.

LookupCurrentConditionsRequest

La definición de la solicitud de las condiciones actuales de calidad del aire.

Campos
location

LatLng

Obligatorio. La longitud y latitud a partir de las cuales la API busca datos sobre las condiciones actuales de la calidad del aire.
extra_computations[]

ExtraComputation

Opcional. Funciones adicionales que se pueden habilitar de forma opcional Si especificas cálculos adicionales, se mostrarán los elementos y campos relevantes en la respuesta.
uaqi_color_palette

ColorPalette

Opcional. Determina la paleta de colores que se utiliza para los datos que proporciona el "Índice Universal de Calidad del Aire" (UAQI). Esta paleta de colores es relevante solo para UAQI; otros AQI tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expresa una relación de “país/región con el índice de calidad de aire”. Vincula un país o una región con un ICA deseado para que se muestren los datos de la calidad del aire necesarios para ese país o región según el ICA elegido. Este parámetro se puede usar para especificar un ICA no predeterminado para un país determinado; por ejemplo, para obtener el índice de la EPA de EE.UU. para Canadá en lugar del índice predeterminado para Canadá.
universal_aqi

bool

Opcional. Si se configura como true, el ICA universal se incluirá en el campo "Índices" de la respuesta. El valor predeterminado es verdadero.
language_code

string

Opcional. Permite que el cliente elija el idioma de la respuesta. Si no se pueden proporcionar datos para ese idioma, la API usa la coincidencia más cercana. Los valores permitidos se basan en el estándar IETF. El valor predeterminado es "en".

LookupCurrentConditionsResponse

Campos
date_time

Timestamp

Una marca de tiempo redondeada hacia abajo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Por ejemplo: “2014-10-02T15:00:00Z”.
region_code

string

El código ISO_3166-1 alpha-2 del país o la región que corresponde a la ubicación proporcionada en la solicitud. Este campo podría omitirse en la respuesta si la ubicación proporcionada en la solicitud reside en un territorio en disputa.
indexes[]

AirQualityIndex

Según los parámetros de la solicitud, esta lista incluirá (hasta) dos índices de calidad del aire:

  • ICA universal. Se mostrará si el valor booleano universalAqi está configurado como verdadero.
  • ICA local. Se mostrará si se especifica el cálculo adicional LOCAL_AQI.
pollutants[]

Pollutant

Una lista de contaminantes que afectan la ubicación especificada en la solicitud. Nota: Este campo se devolverá solo para las solicitudes que especificaron uno o más de los siguientes cálculos adicionales: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Consejos de salud y acciones recomendadas relacionadas con las condiciones de calidad del aire informadas. Las recomendaciones se adaptan de manera diferente para las poblaciones en riesgo, los grupos más sensibles a los contaminantes y la población general.

LookupForecastRequest

El objeto de solicitud de la API de previsión de la calidad del aire.

Campos
location

LatLng

Obligatorio. La latitud y la longitud para las que la API busca datos sobre la calidad del aire.
extra_computations[]

ExtraComputation

Opcional. Funciones adicionales que se pueden habilitar de forma opcional Si especificas cálculos adicionales, se mostrarán los elementos y campos relevantes en la respuesta.
uaqi_color_palette

ColorPalette

Opcional. Determina la paleta de colores que se utiliza para los datos que proporciona el "Índice Universal de Calidad del Aire" (UAQI). Esta paleta de colores es relevante solo para UAQI; otros AQI tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expresa una relación de “país/región con el índice de calidad de aire”. Vincula un país o una región con un ICA deseado para que se muestren los datos de la calidad del aire necesarios para ese país o región según el ICA elegido. Este parámetro se puede usar para especificar un ICA no predeterminado para un país determinado; por ejemplo, para obtener el índice de la EPA de EE.UU. para Canadá en lugar del índice predeterminado para Canadá.
page_size

int32

Opcional. La cantidad máxima de registros de información por hora que se mostrarán por página (valor predeterminado = 24).
page_token

string

Opcional. Un token de página recibido de una llamada de previsión anterior. Se usa para recuperar la página siguiente.
Campo de unión time_range. Es el intervalo de tiempo de los datos obligatorios de previsión de la calidad del aire. El rango debe ser de, al menos, una hora redondeada hacia el futuro. Si no se especifica este campo, se mostrará un error INVALID_ANGUAR. Las direcciones (time_range) solo pueden ser una de las siguientes opciones:
date_time

Timestamp

Una marca de tiempo para la que se deben mostrar los datos de un momento específico. La marca de tiempo se redondea a la hora exacta anterior.

Nota: Esto mostrará datos por hora solo para la marca de tiempo solicitada (es decir, un solo elemento de información por hora). Por ejemplo, una solicitud enviada en la que el parámetro date_time se establece en 2023-01-03T11:05:49Z se redondeará a 2023-01-03T11:00:00Z.
period

Interval

Indica el período de inicio y finalización para obtener los datos de previsión. La marca de tiempo se redondea a la hora exacta anterior.
universal_aqi

bool

Opcional. Si se configura como verdadera, el ICA universal se incluirá en el campo "Índices" de la respuesta (predeterminado = verdadero).
language_code

string

Opcional. Permite que el cliente elija el idioma de la respuesta. Si no se pueden proporcionar datos para ese idioma, la API usa la coincidencia más cercana. Los valores permitidos dependen del estándar IETF (predeterminado = 'en').

LookupForecastResponse

Es el objeto de respuesta de la API de previsión de la calidad del aire.

Campos
hourly_forecasts[]

HourlyForecast

Opcional. Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de previsión, habrá 48 elementos de previsiones por hora.
region_code

string

Opcional. El código ISO_3166-1 alpha-2 del país o la región que corresponde a la ubicación proporcionada en la solicitud. Este campo podría omitirse en la respuesta si la ubicación proporcionada en la solicitud reside en un territorio en disputa.
next_page_token

string

Opcional. El token para recuperar la página siguiente.

HourlyForecast

Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de previsión, habrá 48 elementos de previsiones por hora.

Campos
date_time

Timestamp

Una marca de tiempo redondeada hacia abajo que indica la hora (hora) a la que hacen referencia los datos en el formato “Zulú” RFC3339 UTC. Por ejemplo: “2014-10-02T15:00:00Z”.
indexes[]

AirQualityIndex

Según los parámetros de la solicitud, esta lista incluirá (hasta) dos índices de calidad del aire:

  • ICA universal. Se mostrará si el booleano universal_aqi está configurado como verdadero.
  • ICA local. Se mostrará si se especifica el cálculo adicional LOCAL_AQI.
pollutants[]

Pollutant

Una lista de contaminantes que afectan la ubicación especificada en la solicitud.

Nota: Este campo se devolverá solo para las solicitudes que especificaron uno o más de los siguientes cálculos adicionales: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Consejos de salud y acciones recomendadas relacionadas con las condiciones de calidad del aire informadas. Las recomendaciones se adaptan de manera diferente para las poblaciones en riesgo, los grupos más sensibles a los contaminantes y la población general.

LookupHeatmapTileRequest

Una solicitud de mosaico de mapa de calor.

La estructura cumple con la llamada GET del servidor de mosaicos estándar, es decir, https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}.

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

Campos
map_type

MapType

Obligatorio. El tipo de mapa de calor de la calidad del aire. Define el contaminante que el mapa representará gráficamente.

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

Obligatorio. El nivel de zoom del mapa. Define qué tan grande o pequeño es el contenido de un mapa que aparece en una vista de mapa.

El nivel de zoom 0 es todo el mundo en un solo mosaico. El nivel de zoom 1 es el mundo entero en 4 mosaicos. El nivel de zoom 2 es el mundo entero en 16 mosaicos. El nivel de zoom 16 es el mundo entero en 65,536 mosaicos.

Valores permitidos: de 0 a 16
x

int32

Obligatorio. Define el punto de este a oeste en el mosaico solicitado.
y

int32

Obligatorio. Define el punto norte-sur del mosaico solicitado.

LookupHistoryRequest

El objeto Request de la API de Air Quality History.

Campos
page_size

int32

Opcional. La cantidad máxima de registros de información por hora que se muestran por página. El valor predeterminado es 72 y el valor máximo es 168 (7 días de datos).
page_token

string

Opcional. Un token de página recibido de una llamada del historial anterior. Se usa para recuperar la página siguiente.

Ten en cuenta que cuando proporcionas un valor para este parámetro, todos los demás parámetros deben coincidir con la llamada que proporcionó el token de la página (la llamada anterior).
location

LatLng

Obligatorio. La latitud y la longitud para las que la API busca datos históricos de calidad del aire.
extra_computations[]

ExtraComputation

Opcional. Funciones adicionales que se pueden habilitar de forma opcional Si especificas cálculos adicionales, se mostrarán los elementos y campos relevantes en la respuesta.
uaqi_color_palette

ColorPalette

Opcional. Determina la paleta de colores que se utiliza para los datos que proporciona el "Índice Universal de Calidad del Aire" (UAQI). Esta paleta de colores es relevante solo para UAQI; otros AQI tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expresa una relación de “país/región con el índice de calidad de aire”. Vincula un país o una región con un ICA deseado para que se muestren los datos de la calidad del aire necesarios para ese país o región según el ICA elegido. Este parámetro se puede usar para especificar un ICA no predeterminado para un país determinado; por ejemplo, para obtener el índice de la EPA de EE.UU. para Canadá en lugar del índice predeterminado para Canadá.
Campo de unión time_range. El intervalo de tiempo de los datos de calidad del aire requeridos. Si no se especifica ningún campo relacionado con el intervalo de tiempo, se mostrará un error INVALID_ATTRIBUTE. time_range solo puede ser una de las siguientes opciones: time_range solo puede ser una de las siguientes opciones:
date_time

Timestamp

Una marca de tiempo para la que se deben mostrar los datos históricos. La marca de tiempo se redondea a la hora exacta anterior.

Nota: Esto mostrará datos por hora solo para la marca de tiempo solicitada (es decir, un solo elemento de información por hora). Por ejemplo, una solicitud enviada en la que el parámetro dateTime se establece en 2023-01-03T11:05:49Z se redondeará a 2023-01-03T11:00:00Z.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: “2014-10-02T15:01:23Z” y “2014-10-02T15:01:23.045123456Z”.
hours

int32

Es un número del 1 al 720 que indica el intervalo de horas de la solicitud. Por ejemplo: El valor 48 proporcionará datos de las últimas 48 horas.
period

Interval

Indica el período de inicio y finalización para el que se deben obtener los datos históricos. La marca de tiempo se redondea a la hora exacta anterior.
universal_aqi

bool

Opcional. Si se configura como true, el ICA universal se incluirá en el campo "Índices" de la respuesta. El valor predeterminado es verdadero.
language_code

string

Opcional. Permite que el cliente elija el idioma de la respuesta. Si no se pueden proporcionar datos para ese idioma, la API usa la coincidencia más cercana. Los valores permitidos se basan en el estándar IETF. El valor predeterminado es "en".

LookupHistoryResponse

Campos
hours_info[]

HourInfo

Opcional. Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de historial, habrá 48 elementos de información por hora.
region_code

string

Opcional. El código ISO_3166-1 alpha-2 del país o la región que corresponde a la ubicación proporcionada en la solicitud. Este campo podría omitirse en la respuesta si la ubicación proporcionada en la solicitud reside en un territorio en disputa.
next_page_token

string

Opcional. El token para recuperar la página siguiente.

HourInfo

Contiene la información sobre la calidad del aire cada hora en el rango solicitado. Por ejemplo, si la solicitud es de 48 horas de historial, habrá 48 elementos de información por hora.

Campos
date_time

Timestamp

Una marca de tiempo redondeada hacia abajo que indica la hora a la que hacen referencia los datos en el formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Por ejemplo: “2014-10-02T15:00:00Z”.
indexes[]

AirQualityIndex

Según los parámetros de la solicitud, esta lista incluirá (hasta) dos índices de calidad del aire:

  • ICA universal. Se mostrará si el valor booleano universalAqi está configurado como verdadero.
  • ICA local. Se mostrará si se especifica el cálculo adicional LOCAL_AQI.
pollutants[]

Pollutant

Una lista de contaminantes que afectan la ubicación especificada en la solicitud. Nota: Este campo se devolverá solo para las solicitudes que especificaron uno o más de los siguientes cálculos adicionales: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
health_recommendations

HealthRecommendations

Consejos de salud y acciones recomendadas relacionadas con las condiciones de calidad del aire informadas. Las recomendaciones se adaptan de manera diferente para las poblaciones en riesgo, los grupos más sensibles a los contaminantes y la población general.

MapType

El tipo de mapa de calor de la calidad del aire. Define el contaminante que el mapa representará gráficamente.

Enumeradores
MAP_TYPE_UNSPECIFIED Es el valor predeterminado. El servidor los ignora si se pasa como parámetro.
UAQI_RED_GREEN Paleta de color rojo y verde del Índice Universal de Calidad del Aire
UAQI_INDIGO_PERSIAN Paleta del índice universal de calidad del aire índigo-persiano.
PM25_INDIGO_PERSIAN Paleta de índice PM2.5 de color índigo-persiano.
GBR_DEFRA Paleta de colores del Índice Diario de Calidad del Aire (Reino Unido),
DEU_UBA Paleta de colores del índice de calidad del aire local de Alemania.
CAN_EC Paleta de colores del Índice de Salud de la Calidad del Aire de Canadá.
FRA_ATMO Paleta de colores del Índice de Calidad del Aire de Francia.
US_AQI Paleta de colores del Índice de Calidad del Aire de EE.UU.

Contaminante

Datos sobre un contaminante de la calidad del aire.

Campos
code

string

Es el nombre interno del contaminante. Por ejemplo: “so2”. Puede encontrar una lista de todos los códigos disponibles aquí.
display_name

string

El nombre visible del contaminante. Por ejemplo: “NOx”.
full_name

string

El nombre completo del contaminante. Para los compuestos químicos, es el nombre de la IUPAC. Ejemplo: “Dóxido de azufre”.

Para obtener más información sobre la tabla de nombres de la IUPAC, consulta https://iupac.org/what-we-do/periodic-table-of-elements/.
concentration

Concentration

El nivel de concentración del contaminante medido por una de las unidades estándar de medición de contaminación del aire.
additional_info

AdditionalInfo

Información adicional sobre el contaminante.

AdditionalInfo

Las fuentes de emisión y los efectos para la salud de un contaminante determinado.

Campos
sources

string

Texto que representa las principales fuentes de emisión del contaminante.
effects

string

Texto que representa los principales efectos de la salud del contaminante.

Concentración

Es la concentración de un contaminante determinado en el aire.

Campos
units

Unit

Unidades para medir la concentración de este contaminante.
value

float

Valor de la concentración de contaminantes.

Unidad

Define la unidad que se usa para medir la concentración del contaminante.

Enumeradores
UNIT_UNSPECIFIED Unidad de concentración no especificada.
PARTS_PER_BILLION La unidad de concentración ppb (partes por mil millones).
MICROGRAMS_PER_CUBIC_METER La unidad de concentración “μg/m^3” (microgramos por metro cúbico).