Historique

Le point de terminaison history fournit des informations horaires sur la qualité de l'air pour un lieu donné, pour un (30 jours maximum). Vous pouvez contrôler les IQA et des informations pertinentes sont renvoyées (telles que le niveau de concentration des polluants et recommandations de santé).

Vous pouvez demander un historique de la qualité de l'air par heure à l'aide du history en envoyant une requête HTTP POST à:

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

Inclure les options de requête dans le fichier JSON corps de la requête. Corps de la requête contient le lieu et la période pour lesquels vous souhaitez obtenir historique de la qualité de l'air par heure. Il peut également inclure différentes options pour contrôler quelles informations sur la qualité de l'air inclure dans la réponse.

APIs Explorer vous permet d'effectuer des requêtes en direct afin de vous familiariser l'API et ses options:

Essayer

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 seule heure. demande d'historique à l'aide de history. Dans cet exemple, vous définissez l'emplacement et le code temporel passé.

Remarque :Assurez-vous que le paramètre dateTime spécifie une période dans le au cours des 30 derniers jours.

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 dans une heure

L'appel ci-dessus génère les éléments suivants : Réponse JSON. Pour en savoir plus sur les données de réponse, consultez la section Données de réponse.

Remarque :Par défaut, la réponse inclut l'IQA universel avec l'indice de qualité de base Informations sur l'IQA. L'IQA peut être supprimé ou remplacé par un autre IQA en définissant le ou les paramètres correspondants.

{
    "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

Requête de période

Le code suivant montre comment construire un corps de requête pour une history, qui renvoie plusieurs de l'historique de la qualité de l'air horaire.

Vous pouvez demander plusieurs enregistrements en spécifiant une période, c'est-à-dire un début et l'horodatage de fin, ou en spécifiant le nombre d'heures en arrière en temps réel.

Remarque :Les résultats sont renvoyés dans les pages, les plus récents en la première page. Utilisez la propriété pageSize pour contrôler le nombre maximal résultats par page. Si plusieurs pages sont requises pour récupérer tous les résultats, Chaque page inclut alors la propriété nextPageToken qui contient le jeton que vous pour récupérer la page suivante.

Dans l'exemple ci-dessous, comme vous avez défini la taille de page sur 2, votre demande pour quatre heures d'historique de la qualité de l'air est renvoyé sur deux pages, où chaque page qui contient 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 envoyer une requête similaire en transmettant les codes temporels de début et de fin:

Remarque :Assurez-vous que les paramètres startTime et endTime spécifient une période. au cours des 30 derniers jours.

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 associée à la période

Les appels ci-dessus génèrent un 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 requièrent des données sur la qualité de l'air sur quatre heures. Cependant, comme vous définissez la propriété pageSize à 2 dans la requête, la réponse ne comprend 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. Utiliser ceci pour accéder à la page de résultats suivante, qui contient les deux heures de données.

Pour accéder à la page de résultats suivante, envoyez une seconde requête au point de terminaison history, mais cette fois, définissez la propriété pageToken sur la valeur de nextPageToken à partir de la première réponse.

Remarque :Lorsque vous transmettez la propriété pageToken pour accéder aux pages de données suivantes, toutes les autres paramètres de demande doivent correspondre à l'appel d'origine qui a fourni la page à un jeton d'accès.

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'