Le point de terminaison history fournit
des informations historiques sur la qualité de l'air par heure pour un lieu spécifique, sur une période donnée, jusqu'à 30 jours maximum. Vous pouvez contrôler les indices de qualité de l'air et les informations pertinentes renvoyées (telles que le niveau de concentration des polluants et les recommandations de santé).
Vous pouvez demander l'historique de la qualité de l'air par heure à l'aide du
history
point de terminaison 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 le lieu et la période pour lesquels vous souhaitez obtenir l'historique de la qualité de l'air par heure. Il peut également inclure différentes options pour contrôler les informations sur la qualité de l'air à inclure dans la réponse.
L'APIs Explorer vous permet d'effectuer des requêtes en direct afin de vous familiariser avec l'API et ses options :
Exemple de requête pour une seule heure
Corps de la requête pour une seule heure
Le code suivant montre comment créer un corps de requête pour une requête d'historique d'une heure
à l'aide de la
history méthode.
Dans cet exemple, vous définissez le lieu et l'horodatage 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 pour une seule 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 pour une période
Requête pour une période
Le code suivant montre comment créer un corps de requête pour un
history qui renvoie plusieurs
enregistrements de l'historique de la qualité de l'air par heure.
Vous pouvez demander plusieurs enregistrements en spécifiant une période (c'est-à-dire un horodatage 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 requête pour 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 requête similaire en transmettant les horodatages 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 pour une période
Les appels ci-dessus génèrent une réponse JSON au format 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 des données sur la qualité de l'air pour quatre heures. 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 deux heures de données suivantes.
Pour accéder à la page de résultats suivante, effectuez une deuxième requête auprès du point de terminaison history, mais cette fois-ci, 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
L'APIs Explorer vous permet d'effectuer des exemples de requêtes afin de vous familiariser avec l'API et ses options.
Sélectionnez l'icône d'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, choisissez le compte que vous souhaitez utiliser pour effectuer la requête.
Dans le panneau APIs Explorer, sélectionnez l'icône plein écran fullscreen pour agrandir la fenêtre APIs Explorer.