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 sobre la calidad del aire por hora en más de 100 países, con una resolución de hasta 500 × 500 metros. Incluye más de 70 índices locales, así como categorías y el índice global de calidad del aire.

Permisos 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 para una ubicación específica en un período determinado.

Permisos 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)

Devuelve un array de bytes que contiene los datos de la imagen PNG de la tarjeta.

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

Permisos 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 resumen de las condiciones actuales de la calidad del aire. Existen varios índices en el mundo que cumplen diferentes propósitos y grupos interesados en medir diferentes aspectos de la calidad del aire.

Campos
code

string

Es el código del índice. Este campo representa el índice para fines de programación mediante el uso de mayúsculas y minúsculas en vez de espacios. Ejemplos: “uaqi” y “fra_atmo”.
display_name

string

Es una representación legible por humanos del nombre del índice. Ejemplo: "AQI (US)"
aqi_display

string

Representación textual de la puntuación numérica del índice, que puede incluir símbolos de prefijo o sufijo, y que suele representar la peor puntuación del índice. Ejemplo: >100 o 10 o más.

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

Color

Es 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

Es el símbolo químico del contaminante dominante. Por ejemplo, “CO”.
aqi

int32

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

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

Nota: Este campo se debe usar para cálculos, visualización de 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 usa para los datos proporcionados por el "Índice de calidad del aire universal" (UAQI). Esta paleta de colores solo es relevante para el ICA de la UA, ya que otros ICA tienen una paleta de colores predeterminada que no se puede controlar.

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

CustomLocalAqi

Expresa una relación "país o región a ICA". Vincula un país o una región con un ICA deseado para que los datos de calidad del aire que se requieren para ese país o región se muestren según el ICA elegido.

Campos
region_code

string

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

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

Enumeraciones
EXTRA_COMPUTATION_UNSPECIFIED Es el valor predeterminado. El servidor lo ignora si se pasa como un parámetro.
LOCAL_AQI

Determina si se debe incluir el ICA local (nacional) de la ubicación solicitada (país) 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á los consejos de salud y las acciones recomendadas para las condiciones actuales del ICA.

Las recomendaciones están diseñadas para la población general y seis grupos de población 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 contenido en la respuesta del campo "indexes" incluirá un campo additional_info cuando los datos estén disponibles.
DOMINANT_POLLUTANT_CONCENTRATION

Determina si la respuesta incluirá las concentraciones de los contaminantes dominantes medidos según índices globales o locales.

Si la solicitud especificó el ICA global y el ICA local, es posible que se devuelvan hasta dos códigos de contaminantes.

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

Determina si la respuesta incluirá las concentraciones de todos los contaminantes con las mediciones disponibles según los índices globales o locales.

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

HealthRecommendations

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

Campos
general_population

string

Sin sensibilidades específicas
elderly

string

Jubilados y personas mayores que la población general.
lung_disease_population

string

Sufre de problemas respiratorios y asma.
heart_disease_population

string

Enfermedades del corazón 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, incluidos niños, niños pequeños y bebés.

LookupCurrentConditionsRequest

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

Campos
location

LatLng

Obligatorio. La longitud y la latitud desde las que la API busca datos de las condiciones actuales de la calidad del aire.
extra_computations[]

ExtraComputation

Opcional. Son 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 usa para los datos proporcionados por el "Índice universal de calidad del aire" (UAQI). Esta paleta de colores solo es relevante para el ICA de la UA, ya que otros ICA tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

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

bool

Opcional. Si se establece como verdadero, el ICA universal se incluirá en el campo "indexes" 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 dependen del estándar del IETF. El valor predeterminado es en.

LookupCurrentConditionsResponse

Campos
date_time

Timestamp

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

string

Es 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. Es posible que este campo se omita de la respuesta si la ubicación proporcionada en la solicitud se encuentra 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 se establece en verdadero.
  • ICA local Se mostrará si se especifica el procesamiento adicional LOCAL_AQI.
pollutants[]

Pollutant

Es una lista de contaminantes que afectan la ubicación especificada en la solicitud. Nota: Este campo solo se mostrará para las solicitudes que especifiquen 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 relacionados con las condiciones de calidad del aire informadas Las recomendaciones se adaptan de forma diferente para las poblaciones en riesgo, los grupos con mayor sensibilidad a los contaminantes y la población general.

LookupForecastRequest

Es el objeto de solicitud de la API de Air Quality Forecast.

Campos
location

LatLng

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

ExtraComputation

Opcional. Son 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 usa para los datos proporcionados por el "Índice universal de calidad del aire" (UAQI). Esta paleta de colores solo es relevante para el ICA de la UA, ya que otros ICA tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

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

int32

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

string

Opcional. Es un token de página que se recibió 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 de pronóstico de calidad del aire requeridos. El rango debe ser de, al menos, una hora redondeada en el futuro. Si no especificas este campo, se producirá un error INVALID_ARGUMENT. Las direcciones (time_range) solo pueden ser una de las siguientes opciones:
date_time

Timestamp

Es una marca de tiempo para la que se muestran 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á hacia abajo a 2023-01-03T11:00:00Z.
period

Interval

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

bool

Opcional. Si se establece como verdadero, el ICA universal se incluirá en el campo "indexes" de la respuesta (valor 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 pronóstico de calidad del aire.

Campos
hourly_forecasts[]

HourlyForecast

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

string

Opcional. Es 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. Es posible que este campo se omita de la respuesta si la ubicación proporcionada en la solicitud se encuentra en un territorio en disputa.
next_page_token

string

Opcional. Es el token para recuperar la página siguiente.

HourlyForecast

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

Campos
date_time

Timestamp

Es una marca de tiempo redondeada hacia abajo que indica la hora (hora) a la que se refieren los datos en formato RFC3339 UTC "Zulu". 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 universal_aqi está establecido en verdadero.
  • ICA local Se mostrará si se especifica el procesamiento adicional LOCAL_AQI.
pollutants[]

Pollutant

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

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

HealthRecommendations

Consejos de salud y acciones recomendadas relacionados con las condiciones de calidad del aire informadas Las recomendaciones se adaptan de forma diferente para las poblaciones en riesgo, los grupos con mayor sensibilidad a los contaminantes y la población general.

LookupHeatmapTileRequest

Una solicitud de mosaico de mapa de calor.

La estructura cumple con la llamada GET estándar del servidor de mosaicos, 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. Es 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. Es el nivel de zoom del mapa. Define qué tan grande o pequeño aparece el contenido de un mapa en una vista de mapa.

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

Valores permitidos: 0 a 16
x

int32

Obligatorio. Define el punto este-oeste en la tarjeta solicitada.
y

int32

Obligatorio. Define el punto norte-sur en la tarjeta solicitada.

LookupHistoryRequest

Es el objeto de solicitud de la API de Air Quality History.

Campos
page_size

int32

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

string

Opcional. Es un token de página que se recibió de una llamada de historial anterior. Se usa para recuperar la página siguiente.

Ten en cuenta que, cuando proporciones un valor para este parámetro, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de 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. Son 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 usa para los datos proporcionados por el "Índice universal de calidad del aire" (UAQI). Esta paleta de colores solo es relevante para el ICA de la UA, ya que otros ICA tienen una paleta de colores predeterminada que no se puede controlar.
custom_local_aqis[]

CustomLocalAqi

Opcional. Expresa una relación "país o región a ICA". Vincula un país o una región con un ICA deseado para que los datos de calidad del aire que se requieren para ese país o región se muestren según el ICA elegido. Este parámetro se puede usar para especificar un ICA que no sea predeterminado para un país determinado, por ejemplo, para obtener el índice de la Agencia de Protección Ambiental (EPA) de EE.UU. para Canadá en lugar del índice predeterminado de Canadá.
Campo de unión time_range. Es el intervalo de tiempo de los datos de calidad del aire requeridos. Si no especificas ningún campo relacionado con el período, se mostrará un error INVALID_ARGUMENT. time_range puede ser solo una de las siguientes opciones: time_range puede ser solo una de las siguientes opciones:
date_time

Timestamp

Es 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 de 1 a 720 que indica el intervalo de horas de la solicitud. Por ejemplo, un valor de 48 generará 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 establece como verdadero, el ICA universal se incluirá en el campo "indexes" 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 dependen del estándar del IETF. El valor predeterminado es en.

LookupHistoryResponse

Campos
hours_info[]

HourInfo

Opcional. Contiene la información de la calidad del aire de 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. Es 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. Es posible que este campo se omita de la respuesta si la ubicación proporcionada en la solicitud se encuentra en un territorio en disputa.
next_page_token

string

Opcional. Es el token para recuperar la página siguiente.

HourInfo

Contiene la información de la calidad del aire de 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 se refieren los datos en formato RFC3339 UTC “Zulu”, con una 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 se establece en verdadero.
  • ICA local Se mostrará si se especifica el procesamiento adicional LOCAL_AQI.
pollutants[]

Pollutant

Es una lista de contaminantes que afectan la ubicación especificada en la solicitud. Nota: Este campo solo se mostrará para las solicitudes que especifiquen 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 relacionados con las condiciones de calidad del aire informadas Las recomendaciones se adaptan de forma diferente para las poblaciones en riesgo, los grupos con mayor sensibilidad a los contaminantes y la población general.

MapType

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

Enumeraciones
MAP_TYPE_UNSPECIFIED Es el valor predeterminado. El servidor lo ignora si se pasa como un parámetro.
UAQI_RED_GREEN Paleta de colores rojo-verde del índice universal de calidad del aire.
UAQI_INDIGO_PERSIAN Paleta índigo-persa del Índice Universal de Calidad del Aire.
PM25_INDIGO_PERSIAN Paleta índigo-persa del índice de PM2.5.
GBR_DEFRA Paleta de colores del Índice Diario de Calidad del Aire (Reino Unido).
DEU_UBA Paleta de colores del Índice Local de Calidad del Aire 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 de código del contaminante (por ejemplo, "so2"). Para obtener una lista de los códigos de contaminantes admitidos, consulta Contaminantes informados.
display_name

string

Es el nombre visible del contaminante. Por ejemplo, “NOx”.
full_name

string

El nombre completo del contaminante En el caso de los compuestos químicos, este es el nombre de la IUPAC. Ejemplo: “Dió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

Es el nivel de concentración del contaminante medido con una de las unidades de medida estándar de la contaminación del aire.
additional_info

AdditionalInfo

Información adicional sobre el contaminante.

AdditionalInfo

Las fuentes de emisiones y los efectos en la salud de un contaminante determinado

Campos
sources

string

Texto que representa las principales fuentes de emisiones del contaminante.
effects

string

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

Concentración

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

Campos
units

Unit

Son las unidades para medir esta concentración de contaminantes.
value

float

Es el valor de la concentración del contaminante.

Unidad

Define la unidad que se usa para medir la concentración del contaminante. Para determinar la unidad de concentración predeterminada de un contaminante determinado, consulta la tabla en Contaminantes informados.

Enumeraciones
UNIT_UNSPECIFIED Unidad de concentración no especificada.
PARTS_PER_BILLION La unidad de concentración de ppb (partes por cada mil millones).
MICROGRAMS_PER_CUBIC_METER La unidad de concentración "µg/m^3" (microgramos por metro cúbico).