Method: history.lookup

Renvoie l'historique de la qualité de l'air d'un lieu spécifique pour une période donnée.

Requête HTTP

POST https://airquality.googleapis.com/v1/history:lookup

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "pageSize": integer,
  "pageToken": string,
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Champs
pageSize

integer

Facultatif. Nombre maximal d'enregistrements d'informations par heure à renvoyer par page. La valeur par défaut est 72 et la valeur maximale est 168 (sept jours de données).
pageToken

string

Facultatif. Jeton de page reçu lors d'un appel d'historique précédent. Elle permet de récupérer la page suivante.

Notez que lorsque vous indiquez une valeur pour ce paramètre, tous les autres paramètres fournis doivent correspondre à l'appel qui a fourni le jeton de page (appel précédent).
location

object (LatLng)

Obligatoire. Latitude et longitude pour lesquelles l'API recherche les données de l'historique de la qualité de l'air.
extraComputations[]

enum (ExtraComputation)

Facultatif. Fonctionnalités supplémentaires qui peuvent être activées en option. Si vous spécifiez des calculs supplémentaires, les éléments et champs pertinents seront renvoyés dans la réponse.
uaqiColorPalette

enum (ColorPalette)

Facultatif. Détermine la palette de couleurs utilisée pour les données fournies par l'"Indice universel de la qualité de l'air" (UAQI). Cette palette de couleurs n'est pertinente que pour l'UAQI. Les autres IQA ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée.
customLocalAqis[]

object (CustomLocalAqi)

Facultatif. Indique un "pays/région pour l'IQA" relation. Associe un pays/une région à un IQA souhaité afin que les données sur la qualité de l'air requises pour ce pays/cette région soient affichées en fonction de l'IQA choisi. Ce paramètre permet de spécifier un IQA autre que celui par défaut pour un pays donné, par exemple, afin d'obtenir l'indice de l'Agence américaine de protection de l'environnement pour le Canada plutôt que l'indice par défaut pour le Canada.
dateTime

string (Timestamp format)

Horodatage pour lequel renvoyer des données historiques. Le code temporel est arrondi à l'heure exacte précédente.

Remarque: cette commande ne renverra des données horaires que pour l'horodatage demandé (c'est-à-dire un seul élément d'information horaire). Par exemple, une requête envoyée pour laquelle le paramètre dateTime est défini sur 2023-01-03T11:05:49Z sera arrondie à 2023-01-03T11:00:00Z.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Remarque:Vous pouvez utiliser dateTime ou startTime et endTime dans une requête.
hours

integer

Nombre compris entre 1 et 720 indiquant la plage d'heures d'ouverture de la requête. Par exemple, la valeur 48 permet d'obtenir les données des dernières 48 heures.
period

object (Interval)

Indique la période startTime et endTime pour laquelle obtenir les données historiques. Le code temporel est arrondi à l'heure exacte précédente.

Remarque:Vous pouvez utiliser dateTime ou startTime et endTime dans une requête.
universalAqi

boolean

Facultatif. Si elle est définie sur "True", l'IQA universel est inclus dans la métrique "Indices" de la réponse. La valeur par défaut est "true" (vrai).
languageCode

string

Facultatif. Permet au client de choisir la langue de la réponse. Si les données ne peuvent pas être fournies pour ce langage, l'API utilise la correspondance la plus proche. Les valeurs autorisées sont basées sur la norme IETF. La valeur par défaut est "en".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "hoursInfo": [
    {
      object (HourInfo)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
Champs
hoursInfo[]

object (HourInfo)

Facultatif. Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la demande porte sur 48 heures d'historique, il y aura 48 éléments d'informations horaires.
regionCode

string

Facultatif. Code ISO_3166-1 alpha-2 du pays ou de la région correspondant à l'emplacement fourni dans la requête. Ce champ peut être omis de la réponse si la zone géographique indiquée dans la demande se trouve dans un territoire contesté.
nextPageToken

string

Facultatif. Jeton permettant de récupérer la page suivante.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.

HourInfo

Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la demande porte sur 48 heures d'historique, il y aura 48 éléments d'informations horaires.

Représentation JSON 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
Champs
dateTime

string (Timestamp format)

Code temporel arrondi indiquant l'heure à laquelle les données font référence dans le document RFC3339 UTC "Zulu" avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Par exemple : "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

En fonction des paramètres de demande, cette liste comprendra jusqu'à deux indices de la qualité de l'air:

  • IQA universel. Sera renvoyé si la valeur booléenne "UniversalAqi" est définie sur "true".
  • IQA local. Sera renvoyé si le calcul supplémentaire LOCAL_AQI est spécifié.
pollutants[]

object (Pollutant)

Liste des polluants affectant l'emplacement spécifié dans la requête. Remarque: Ce champ est renvoyé uniquement pour les requêtes spécifiant un ou plusieurs des calculs supplémentaires suivants: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

Conseils de santé et actions recommandées en lien avec les conditions de qualité de l'air signalées. Les recommandations sont adaptées différemment aux populations à risque, aux groupes plus sensibles aux polluants et à la population globale.