Le point de terminaison history fournit des informations historiques sur la qualité de l'air heure par heure pour un lieu spécifique, pour une période donnée, jusqu'à un maximum de 30 jours. Vous pouvez contrôler les indices de qualité de l'air et les informations pertinentes renvoyés (comme le niveau de concentration des polluants et les recommandations de santé).
Vous pouvez demander l'historique de la qualité de l'air horaire à l'aide du point de terminaison history en envoyant une requête HTTP POST à l'adresse suivante :
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
Incluez les options de votre requête dans le corps de la requête JSON. Le corps de la requête contient l'emplacement et la plage horaire pour lesquels vous souhaitez obtenir l'historique horaire de la qualité de l'air. Il peut également inclure différentes options pour contrôler les informations sur la qualité de l'air à inclure dans la réponse.
APIs Explorer vous permet d'envoyer des requêtes en direct pour vous familiariser avec l'API et ses options :
Exemple de demande pour une heure
Corps de la requête pour une seule heure
Le code suivant montre comment créer un corps de requête pour une demande d'historique d'une heure à l'aide de la méthode history.
Dans cet exemple, vous définissez l'emplacement et le code temporel passé.
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'
Réponse sous une heure
L'appel ci-dessus génère la réponse JSON suivante. Pour en savoir plus sur les données de réponse, consultez Données de réponse.
{ "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" }
Exemple de requête de période
Demande de période
Le code suivant montre comment construire un corps de requête pour un history qui renvoie plusieurs enregistrements de données historiques sur la qualité de l'air par heure.
Vous pouvez demander plusieurs enregistrements en spécifiant une période (c'est-à-dire un code temporel de début et de fin) ou en indiquant le nombre d'heures à remonter à partir de l'heure actuelle.
Dans l'exemple ci-dessous, comme vous avez défini la taille de la page sur 2, votre demande de quatre heures d'historique de la qualité de l'air est renvoyée sur deux pages, chacune contenant deux heures de données.
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'
Vous pouvez effectuer une demande similaire en transmettant les codes temporels de début et de fin :
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'
Réponse sur la période
Les appels ci-dessus génèrent une réponse JSON sous la forme ci-dessous. Pour en savoir plus sur les données de réponse, consultez Données de réponse.
Les deux appels ci-dessus demandent quatre heures de données sur la qualité de l'air. Toutefois, comme vous avez défini la propriété pageSize sur 2 dans la requête, la réponse n'inclut que les résultats des deux dernières heures.
{ "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" }
Notez que la réponse inclut également la propriété nextPageToken. Utilisez cette propriété pour accéder à la page de résultats suivante, qui contient les données des deux heures suivantes.
Pour accéder à la page de résultats suivante, envoyez une deuxième requête au point de terminaison history, mais cette fois, définissez la propriété pageToken sur la valeur de nextPageToken de la première réponse.
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'
Essayer
APIs Explorer vous permet d'effectuer des exemples de requêtes pour vous familiariser avec l'API et ses options.
Sélectionnez l'icône API api à droite de la page.
Vous pouvez également modifier les paramètres de la requête.
Sélectionnez le bouton Exécuter. Dans la boîte de dialogue, sélectionnez le compte que vous souhaitez utiliser pour envoyer la demande.
Dans le panneau APIs Explorer, sélectionnez l'icône plein écran fullscreen pour développer la fenêtre APIs Explorer.