Historique

Le point de terminaison history fournit l'historique des informations sur la qualité de l'air par heure pour un lieu spécifique, pour une période donnée, jusqu'à 30 jours maximum. Vous pouvez contrôler les IQA et les informations pertinentes qui sont renvoyées (par exemple, 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 point de terminaison history en envoyant une requête HTTP POST à l'adresse:

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

Incluez vos options de requête dans le corps de la requête JSON. Le corps de la requête contient l'emplacement et la période pour laquelle 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.

APIs Explorer vous permet d'effectuer des requêtes en temps réel afin de vous familiariser avec l'API et ses options:

Essayer

Exemple de requête d'une heure

Corps de la requête pour une heure

Le code suivant montre comment créer un corps de requête pour une seule heure d'historique à l'aide de la méthode history. Dans cet exemple, vous définissez l'emplacement et l'ancien code temporel.

Remarque :Assurez-vous que le paramètre dateTime spécifie une période 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 en 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.

Remarque :Par défaut, la réponse inclut l'IQA universel avec les informations de base sur l'IQA. L'IQA peut être supprimé ou remplacé par un autre 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"
}

Remarque :Si la valeur d'un champ color est 0, ce champ est omis de la réponse.

Exemple de requête de période

Requête de 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 plage temporelle, c'est-à-dire un code temporel de début et de fin, ou en spécifiant le nombre d'heures en arrière par rapport à l'heure actuelle.

Remarque :Les résultats sont renvoyés par pages, les plus récents étant affichés sur la première page. Utilisez la propriété pageSize pour contrôler le nombre maximal de résultats par page. Si plusieurs pages sont nécessaires pour récupérer tous les résultats, chaque page inclut la propriété nextPageToken qui contient le jeton que vous utilisez 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 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 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 de 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 la section Données de réponse.

Les deux appels ci-dessus demandent des données sur la qualité de l'air sur 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 suivante des résultats, qui contient les deux heures de données suivantes.

Pour accéder à la page de résultats suivante, effectuez 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.

Remarque :Lorsque vous transmettez la propriété pageToken pour accéder aux pages de données suivantes, tous les autres paramètres de requête doivent correspondre à l'appel d'origine ayant fourni le jeton de page.

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'