Method: history.lookup

Affiche l'historique de la qualité de l'air pour un lieu spécifique pendant 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)
    }
  ],

  // Union field time_range can be only one of the following:
  "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 horaires à 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 précédent appel de l'historique. Il 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 ayant fourni le jeton de page (l'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 pouvant être activées (facultatif). 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 ne concerne que l'IQA. Les autres IQ ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée.

customLocalAqis[]

object (CustomLocalAqi)

Facultatif. Exprime une relation "pays/région vers l'IQA". associe un pays/une région à l'IQA souhaité afin que les données sur la qualité de l'air requises pour ce pays/cette région s'affichent 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, pour obtenir l'index de l'EPA des États-Unis pour le Canada plutôt que l'indice par défaut pour le Canada.

Champ d'union time_range. Période des données requises sur la qualité de l'air. Si vous ne spécifiez pas de champ lié à la période, une erreur INVALID_ARGUMENT sera renvoyée. Le champ "time_range" ne peut être que l'un des suivants: time_range ne peut être que l'un des suivants:
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 méthode ne renverra des données horaires que pour le code temporel demandé (c'est-à-dire un seul élément d'information horaire). Par exemple, une requête envoyée dont le paramètre dateTime est défini sur 2023-01-03T11:05:49Z sera arrondie à 2023-01-03T11:00:00Z.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

hours

integer

Nombre compris entre 1 et 720 qui indique la plage d'heures pour la requête. Par exemple, la valeur 48 renvoie les données des dernières 48 heures.

period

object (Interval)

Indique la période de début et de fin pour laquelle vous souhaitez obtenir les données historiques. Le code temporel est arrondi à l'heure exacte précédente.

universalAqi

boolean

Facultatif. Si ce paramètre est défini sur "true", l'IQA universel est inclus dans le champ "index" 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 aucune donnée ne peut être fournie pour cette langue, l'API utilise la correspondance la plus proche. Les valeurs autorisées dépendent de 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 dans la plage demandée. Par exemple, si la requête 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 à la zone géographique indiquée dans la requête. Ce champ peut être omis de la réponse si le lieu indiqué dans la requête 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.

Intervalle

Représente un intervalle de temps, encodé en tant que début d'horodatage (inclus) et fin d'horodatage (exclusif).

Le début doit être inférieur ou égal à la fin. Lorsque le début est égal à la fin, l'intervalle est vide (ne correspond à aucune heure). Si le début et la fin ne sont pas spécifiés, l'intervalle correspond à n'importe quelle heure.

Représentation JSON
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Facultatif. Début de l'intervalle inclusif.

Si cet intervalle est spécifié, un code temporel correspondant à cet intervalle doit être identique ou ultérieur au début.

endTime

string (Timestamp format)

Facultatif. Fin exclusive de l'intervalle.

Si cet intervalle est spécifié, un code temporel correspondant à cet intervalle doit être situé avant la fin.

HourInfo

Contient les informations sur la qualité de l'air pour chaque heure dans la plage demandée. Par exemple, si la requête 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 inférieur indiquant l'heure à laquelle les données font référence au format RFC3339 UTC "Zulu", avec une résolution en nanosecondes et jusqu'à neuf chiffres après la virgule. Exemple: "2014-10-02T15:00:00Z".

indexes[]

object (AirQualityIndex)

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

  • IQA universel Sera renvoyé si la valeur booléenne universelleAqi est définie sur "true".
  • IQA local. Est 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 n'est renvoyé que 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 mesures recommandées concernant les conditions de qualité de l'air signalées. Les recommandations sont adaptées différemment pour les populations à risque, les groupes plus sensibles aux polluants et la population globale.