Cette page a été traduite par l'API Cloud Translation.

Method: forecast.lookup

Requête HTTP
Corps de la requête
- Représentation JSON
Corps de la réponse
- Représentation JSON
Champs d'application des autorisations
HourlyForecast <ph type="x-smartling-placeholder">
- Représentation JSON

Affiche les prévisions de la qualité de l'air pour un lieu spécifique sur 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

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 }

{
  "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 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.
`pageSize`	`integer` Facultatif. Nombre maximal d'enregistrements d'informations par heure à renvoyer par page (24 par défaut).
`pageToken`	`string` Facultatif. Jeton de page reçu d'un appel de prévision précédent. Elle permet de récupérer la page suivante.
`dateTime`	`string (Timestamp format)` Horodatage pour lequel renvoyer les données correspondant à un moment précis. Le code temporel est arrondi à l'heure exacte précédente. Cette option renvoie des données horaires uniquement 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 la période `startTime` et `endTime` pour laquelle obtenir les données de prévision. Le champ `endTime` est inclus. 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 (par défaut = true).
`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 (par défaut = "en").

Corps de la réponse

Objet de 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

Champs
`hourlyForecasts[]`	`object (HourlyForecast)` 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 une prévision de 48 heures, il y aura 48 éléments de prévisions 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.

hourlyForecasts[]

object (HourlyForecast)

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 une prévision de 48 heures, il y aura 48 éléments de prévisions 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.

HourlyForecast

Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la demande porte sur une prévision de 48 heures, il y aura 48 éléments de prévisions 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 (heure) à laquelle les données font référence dans le document RFC3339 UTC "Zulu" . 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. Cette valeur est renvoyée 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.