Method: forecast.lookup

Affiche les prévisions de qualité de l'air pour un lieu spécifique pendant une période donnée.

Requête HTTP

POST https://airquality.googleapis.com/v1/forecast: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 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
Champs
location

object (LatLng)

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

enum (ExtraComputation)

Facultatif. Fonctionnalités supplémentaires pouvant ê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 ne concerne que les UAQI. Les autres 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 pour 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, afin d'obtenir l'indice de l'EPA des États-Unis pour le Canada plutôt que l'indice par défaut pour le Canada.
pageSize

integer

Facultatif. Nombre maximal d'enregistrements d'informations horaires à afficher par page (par défaut = 24).
pageToken

string

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

string (Timestamp format)

Horodatage pour lequel renvoyer les données d'un moment précis. Le code temporel est arrondi à l'heure exacte précédente.

Les données horaires ne s'affichent 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.

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

object (Interval)

Indique les périodes startTime et endTime pour lesquelles vous souhaitez obtenir les données de prévision. La endTime est inclusive. 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 le champ "index" de la réponse (par défaut = true).
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 (par défaut, "en").

Corps de la réponse

Objet réponse de l'API de prévision de la qualité de l'air.

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

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

object (HourlyForecast)

Facultatif. Contient des informations sur la qualité de l'air pour chaque heure dans la plage demandée. Par exemple, si la demande porte sur 48 heures de prévision, les prévisions horaires seront au nombre de 48.
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.

HourlyForecast

Contient des informations sur la qualité de l'air pour chaque heure dans la plage demandée. Par exemple, si la demande porte sur 48 heures de prévision, les prévisions horaires seront au nombre de 48.

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

string (Timestamp format)

Code temporel arrondi au format inférieur indiquant l'heure (heure) à laquelle les données se réfèrent, au format RFC3339 UTC "Zulu". Par 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 la qualité de l'air:

  • IQA universel. Est renvoyé si la valeur booléenne universalAqi 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 qui ont spécifié 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 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.