El extremo history proporciona
información histórica por hora sobre la calidad del aire de una ubicación específica, para un período
determinado, hasta un máximo de 30 días. Puedes controlar qué ICA y qué información pertinente se muestran (como el nivel de concentración de contaminantes y las recomendaciones de salud).
Para solicitar el historial de la calidad del aire por hora, usa el
history
extremo y envía una solicitud HTTP POST a:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Incluye las opciones de solicitud en el cuerpo de la solicitud JSON request body. El cuerpo de la solicitud contiene la ubicación y el período para los que deseas obtener el historial de la calidad del aire por hora. También puede incluir varias opciones para controlar qué información sobre la calidad del aire se incluirá en la respuesta.
El Explorador de APIs te permite realizar solicitudes en vivo para que puedas familiarizarte con la API y sus opciones:
Ejemplo de una solicitud de una hora
Cuerpo de la solicitud de una hora
En el siguiente código, se muestra cómo crear un cuerpo de solicitud para una solicitud de historial de una hora
con el método
history.
En este ejemplo, se establece la ubicación y la marca de tiempo anterior.
curl -X POST -d '{
"dateTime": "2023-06-26T15:01:23Z",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Respuesta de una hora
La llamada anterior genera la siguiente respuesta JSON. Para obtener más detalles sobre los datos de respuesta, consulta Datos de respuesta.
{ "hoursInfo": [ { "dateTime": "2023-06-26T15:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 73, "aqiDisplay": "73", "color": { "red": 118, "green": 202, "blue": 51, "alpha": 255 }, "category": "Good air quality", "dominantPollutant": "pm10" } ] } ], "regionCode": "us" }
Ejemplo de solicitud de período
Solicitud de período
En el siguiente código, se muestra cómo crear un cuerpo de solicitud para un
history que muestra varios
registros del historial de la calidad del aire por hora.
Puedes solicitar varios registros si especificas un período, es decir, una marca de tiempo de inicio y finalización, o si especificas la cantidad de horas anteriores a la hora actual.
En el siguiente ejemplo, como estableciste el tamaño de la página en 2, tu solicitud de cuatro horas de historial de calidad del aire se muestra en dos páginas, en las que cada una contiene dos horas de datos.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Puedes realizar una solicitud similar si pasas las marcas de tiempo de inicio y finalización:
curl -X POST -d '{
"period": {
"startTime":"2023-06-15T08:00:00Z",
"endTime":"2023-06-15T12:00:00Z"
},
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Respuesta de período
Las llamadas anteriores generan una respuesta JSON en el siguiente formato. Para obtener más detalles sobre los datos de respuesta, consulta Datos de respuesta.
Ambas llamadas anteriores solicitan datos de calidad del aire de cuatro horas. Sin embargo, como estableciste la propiedad pageSize en 2 en la solicitud, la respuesta solo incluye resultados de las dos horas más recientes.
{ "hoursInfo": [ { "dateTime": "2023-06-15T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 83, "aqiDisplay": "83", "color": { "red": 74, "green": 185, "blue": 54, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] }, { "dateTime": "2023-06-15T10:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 89, "aqiDisplay": "89", "color": { "red": 48, "green": 175, "blue": 55, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] } ], "regionCode": "us", "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA" }
Ten en cuenta que la respuesta también incluye la propiedad nextPageToken. Usa esta propiedad para acceder a la siguiente página de resultados, que contiene las siguientes dos horas de datos.
Para acceder a la siguiente página de resultados, realiza una segunda solicitud al extremo history, pero esta vez establece la propiedad pageToken en el valor de nextPageToken de la primera respuesta.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
Pruébalo
El Explorador de APIs te permite realizar solicitudes de muestra para que puedas familiarizarte con la API y sus opciones.
Selecciona el ícono de API api en el lado derecho de la página.
De manera opcional, edita los parámetros de la solicitud.
Selecciona el botón Ejecutar. En el diálogo, elige la cuenta que deseas usar para realizar la solicitud.
En el panel Explorador de APIs, selecciona el ícono de pantalla completa fullscreen para expandir la ventana del Explorador de APIs.