Index
AirQuality
(interface)AirQualityIndex
(message)ColorPalette
(enum)CustomLocalAqi
(message)ExtraComputation
(enum)HealthRecommendations
(message)LookupCurrentConditionsRequest
(message)LookupCurrentConditionsResponse
(message)LookupForecastRequest
(message)LookupForecastResponse
(message)LookupForecastResponse.HourlyForecast
(message)LookupHeatmapTileRequest
(message)LookupHistoryRequest
(message)LookupHistoryResponse
(message)LookupHistoryResponse.HourInfo
(message)MapType
(enum)Pollutant
(message)Pollutant.AdditionalInfo
(message)Pollutant.Concentration
(message)Pollutant.Concentration.Unit
(enum)
AirQuality
Services de qualité de l'air
LookupCurrentConditions |
---|
Le point de terminaison "Conditions actuelles" fournit des informations sur la qualité de l'air par heure dans plus de 100 pays, avec une résolution maximale de 500 x 500 mètres. Inclut plus de 70 indices locaux, ainsi que des catégories et un indice de la qualité de l'air mondial.
|
LookupForecast |
---|
Affiche les prévisions de qualité de l'air pour un lieu spécifique sur une période donnée.
|
LookupHeatmapTile |
---|
Renvoie un tableau d'octets contenant les données de l'image PNG de la carte.
|
LookupHistory |
---|
Affiche l'historique de la qualité de l'air pour un lieu spécifique sur une période donnée.
|
AirQualityIndex
Objet de base permettant de représenter différentes métriques de qualité de l'air. Combinées, ces métriques fournissent un instantané des conditions de qualité de l'air actuelles. Il existe plusieurs indices dans le monde, qui servent à différents objectifs et à différents groupes qui souhaitent mesurer différents aspects de la qualité de l'air.
Champs | |
---|---|
code |
Code de l'index. Ce champ représente l'index à des fins de programmation en utilisant le style snake case au lieu d'espaces. Exemples: "uaqi", "fra_atmo". |
display_name |
Représentation lisible du nom de l'index. Exemple: "IQA (États-Unis)" |
aqi_display |
Représentation textuelle du score numérique de l'indice, qui peut inclure des symboles de préfixe ou de suffixe, et qui représente généralement le score d'indice le plus faible. Exemple: >100 ou 10+. Remarque: Ce champ doit être utilisé lorsque vous souhaitez afficher le score de l'index. Pour les index non numériques, ce champ est vide. |
color |
Couleur utilisée pour représenter le score numérique de l'IQA. |
category |
Classification textuelle de l'interprétation de la note numérique de l'indice. (par exemple, "Excellente qualité de l'air"). |
dominant_pollutant |
Symbole chimique du polluant dominant. Exemple: "CO". |
aqi |
Score numérique de l'index. Exemples: 10, 100. La valeur n'est pas normalisée et ne doit être interprétée que dans le contexte de l'indice de qualité de l'air associé. Pour les index non numériques, ce champ ne sera pas renvoyé. Remarque: Ce champ doit être utilisé pour les calculs, l'affichage de graphiques, etc. Pour afficher le score de l'indice, vous devez utiliser le champ d'affichage de l'IQA. |
ColorPalette
Détermine la palette de couleurs utilisée pour les données fournies par l'indice de qualité de l'air universel (IQA). Cette palette de couleurs ne s'applique qu'à l'IQA de l'UA. Les autres IQA ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée.
Enums | |
---|---|
COLOR_PALETTE_UNSPECIFIED |
Valeur par défaut. Ignoré s'il est transmis en tant que paramètre. |
RED_GREEN |
Détermine si une palette rouge/verte doit être utilisée. |
INDIGO_PERSIAN_DARK |
Détermine si une palette indigo/perse (thème sombre) doit être utilisée. |
INDIGO_PERSIAN_LIGHT |
Détermine si une palette indigo/perse (thème clair) doit être utilisée. |
CustomLocalAqi
Indique une relation "pays/région/IQA". Associe un pays/une région à un IQA souhaité afin que les données de qualité de l'air requises pour ce pays/cette région soient affichées en fonction de l'IQA choisi.
Champs | |
---|---|
region_code |
Pays/région nécessitant l'IQA personnalisé La valeur doit être fournie au format ISO 3166-1 alpha-2. |
aqi |
IQA à associer au pays/à la région. La valeur doit être un code d'index valide. |
ExtraComputation
Fonctionnalités supplémentaires pouvant être activées Si vous spécifiez des calculs supplémentaires, les éléments et les champs pertinents seront renvoyés dans la réponse.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Valeur par défaut. Le serveur l'ignore s'il est transmis en tant que paramètre. |
LOCAL_AQI |
Détermine si l'IQA local (national) de l'emplacement (pays) demandé doit être inclus dans la réponse. Si elle est spécifiée, la réponse contient une structure de données "air_quality_index" avec toutes les données pertinentes sur l'IQA local de l'emplacement. |
HEALTH_RECOMMENDATIONS |
Indique si la réponse inclura les conseils de santé et les actions recommandées en fonction de l'IQA actuel. Les recommandations sont adaptées à la population générale et à six groupes à risque plus sensibles aux polluants que la population générale. Si ce champ est spécifié, il sera renseigné dans la réponse lorsque les données pertinentes seront disponibles. |
POLLUTANT_ADDITIONAL_INFO |
Indique si les informations supplémentaires de chaque polluant doivent être incluses dans la réponse. Si spécifié, chaque objet d'indice de la qualité de l'air contenu dans la réponse du champ "indexes" inclura un champ |
DOMINANT_POLLUTANT_CONCENTRATION |
Détermine si la réponse inclut les concentrations des polluants dominants mesurées selon des indices globaux et/ou locaux. Si la requête spécifie à la fois l'IQA global et l'IQA local, jusqu'à deux codes de polluant peuvent être renvoyés. Si spécifié, l'objet polluant dominant contenu dans la liste "polluants" inclura un champ |
POLLUTANT_CONCENTRATION |
Détermine si la réponse inclut les concentrations de tous les polluants avec les mesures disponibles selon des indices globaux et/ou locaux. Si spécifié, chaque objet polluant contenu dans le champ "polluants" de la réponse inclura un champ |
HealthRecommendations
Recommandations sanitaires pour différents groupes de population au format texte libre. Les recommandations sont dérivées des conditions de qualité de l'air associées.
Champs | |
---|---|
general_population |
Aucune sensibilité spécifique. |
elderly |
Les retraités et les personnes plus âgées que la population générale |
lung_disease_population |
Problèmes respiratoires et asthme |
heart_disease_population |
Maladies cardiaques et du système circulatoire |
athletes |
Sports et autres activités physiques intenses en plein air |
pregnant_women |
Femmes à tous les stades de la grossesse |
children |
Populations plus jeunes, y compris les enfants, les tout-petits et les bébés |
LookupCurrentConditionsRequest
Définition de la requête pour les conditions actuelles de la qualité de l'air.
Champs | |
---|---|
location |
Obligatoire. Latitude et longitude à partir desquelles l'API recherche les données sur les conditions actuelles de la qualité de l'air. |
extra_computations[] |
Facultatif. Fonctionnalités supplémentaires pouvant être activées Si vous spécifiez des calculs supplémentaires, les éléments et les champs pertinents seront renvoyés dans la réponse. |
uaqi_color_palette |
Facultatif. Détermine la palette de couleurs utilisée pour les données fournies par l 'indice de qualité de l'air universel (IQA). Cette palette de couleurs ne s'applique qu'à l'IQA de l'UA. Les autres IQA ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée. |
custom_local_aqis[] |
Facultatif. Indique une relation "pays/région/IQA". Associe un pays/une région à un IQA souhaité afin que les données de 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 pour obtenir l'indice de l'EPA des États-Unis pour le Canada plutôt que l'indice par défaut pour le Canada. |
universal_aqi |
Facultatif. Si cette valeur est définie sur "true", l'IQA universel sera inclus dans le champ "indexes" de la réponse. La valeur par défaut est "true" (vrai). |
language_code |
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 reposent sur la norme IETF. La valeur par défaut est "en". |
LookupCurrentConditionsResponse
Champs | |
---|---|
date_time |
Horodatage arrondi au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Par exemple: "2014-10-02T15:00:00Z". |
region_code |
Code ISO-3166-1 alpha-2 du pays/région correspondant à l'emplacement indiqué dans la requête. Ce champ peut être omis de la réponse si l'établissement indiqué dans la requête se trouve dans un territoire contesté. |
indexes[] |
En fonction des paramètres de la requête, cette liste comprendra (jusqu'à) deux indices de qualité de l'air:
|
pollutants[] |
Liste des polluants affectant l'emplacement spécifié dans la requête. Remarque: Ce champ ne sera 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. |
health_recommendations |
Conseils de santé et actions recommandées en fonction des conditions de qualité de l'air signalées Les recommandations sont adaptées différemment pour les populations à risque, les groupes les plus sensibles aux polluants et la population générale. |
LookupForecastRequest
Objet de la requête de l'API de prévision de la qualité de l'air.
Champs | |
---|---|
location |
Obligatoire. Latitude et longitude pour lesquelles l'API recherche des données sur la qualité de l'air. |
extra_computations[] |
Facultatif. Fonctionnalités supplémentaires pouvant être activées Si vous spécifiez des calculs supplémentaires, les éléments et les champs pertinents seront renvoyés dans la réponse. |
uaqi_color_palette |
Facultatif. Détermine la palette de couleurs utilisée pour les données fournies par l 'indice de qualité de l'air universel (IQA). Cette palette de couleurs ne s'applique qu'à l'IQA de l'UA. Les autres IQA ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée. |
custom_local_aqis[] |
Facultatif. Indique une relation "pays/région/IQA". Associe un pays/une région à un IQA souhaité afin que les données de 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 pour obtenir l'indice de l'EPA des États-Unis pour le Canada plutôt que l'indice par défaut pour le Canada. |
page_size |
Facultatif. Nombre maximal d'enregistrements d'informations horaires à renvoyer par page (par défaut : 24). |
page_token |
Facultatif. Jeton de page reçu d'un appel de prévision précédent. Il permet de récupérer la page suivante. |
Champ d'union time_range . Période des données de prévision de la qualité de l'air requises. La plage doit être située au moins une heure arrondie dans le futur. Si vous ne spécifiez pas ce champ, une erreur INVALID_ARGUMENT s'affiche. time_range ne peut être qu'un des éléments suivants : |
|
date_time |
Code temporel pour lequel renvoyer les données à un moment précis. Le code temporel est arrondi à l'heure exacte précédente. Remarque: Cette requête renvoie uniquement les données horaires pour l'horodatage demandé (c'est-à-dire un seul élément d'informations horaires). Par exemple, une requête envoyée pour laquelle le paramètre date_time est défini sur 2023-01-03T11:05:49Z sera arrondie à 2023-01-03T11:00:00Z. |
period |
Indique la période de début et de fin pour laquelle obtenir les données de prévision. Le code temporel est arrondi à l'heure exacte précédente. |
universal_aqi |
Facultatif. Si cette valeur est définie sur "true", l'IQA universel sera inclus dans le champ "indexes" de la réponse (valeur par défaut : "true"). |
language_code |
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 reposent sur la norme IETF (par défaut = "en"). |
LookupForecastResponse
Objet de réponse de l'API de prévision de la qualité de l'air.
Champs | |
---|---|
hourly_forecasts[] |
Facultatif. Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la requête concerne 48 heures de prévisions, il y aura 48 éléments de prévisions horaires. |
region_code |
Facultatif. Code ISO-3166-1 alpha-2 du pays/région correspondant à l'emplacement indiqué dans la requête. Ce champ peut être omis de la réponse si l'établissement indiqué dans la requête se trouve dans un territoire contesté. |
next_page_token |
Facultatif. Jeton permettant de récupérer la page suivante. |
HourlyForecast
Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la requête concerne 48 heures de prévisions, il y aura 48 éléments de prévisions horaires.
Champs | |
---|---|
date_time |
Code temporel arrondi indiquant l'heure (heure) à laquelle les données font référence au format RFC3339 UTC "Zulu". Par exemple: "2014-10-02T15:00:00Z". |
indexes[] |
En fonction des paramètres de la requête, cette liste comprendra (jusqu'à) deux indices de qualité de l'air:
|
pollutants[] |
Liste des polluants affectant l'emplacement spécifié dans la requête. Remarque: Ce champ ne sera 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. |
health_recommendations |
Conseils de santé et actions recommandées en fonction des conditions de qualité de l'air signalées Les recommandations sont adaptées différemment pour les populations à risque, les groupes les plus sensibles aux polluants et la population générale. |
LookupHeatmapTileRequest
Requête de carte de densité.
La structure est conforme à l'appel GET du serveur de tuiles standard, à savoir https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}.
Exemple: https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1
Champs | |
---|---|
map_type |
Obligatoire. Type de la carte de densité de la qualité de l'air. Définit le polluant que la carte représentera graphiquement.
|
zoom |
Obligatoire. Niveau de zoom de la carte. Définit la taille du contenu d'une carte dans une vue cartographique. Le niveau de zoom 0 correspond à l'ensemble du monde dans une seule tuile. Le niveau de zoom 1 correspond à l'ensemble du monde en quatre tuiles. Au niveau de zoom 2, le monde entier est divisé en 16 tuiles. Le niveau de zoom 16 correspond à l'ensemble du monde en 65 536 tuiles. Valeurs autorisées: 0 à 16 |
x |
Obligatoire. Définit le point est-ouest de la tuile demandée. |
y |
Obligatoire. Définit le point nord-sud de la tuile demandée. |
LookupHistoryRequest
Objet de la requête de l'API "Historique de la qualité de l'air".
Champs | |
---|---|
page_size |
Facultatif. Nombre maximal d'enregistrements d'informations horaires à renvoyer par page. La valeur par défaut est de 72, et la valeur maximale est de 168 (7 jours de données). |
page_token |
Facultatif. Jeton de page reçu d'un appel d'historique précédent. Il permet de récupérer la page suivante. Notez que lorsque vous fournissez 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 |
Obligatoire. Latitude et longitude pour lesquelles l'API recherche des données historiques sur la qualité de l'air. |
extra_computations[] |
Facultatif. Fonctionnalités supplémentaires pouvant être activées Si vous spécifiez des calculs supplémentaires, les éléments et les champs pertinents seront renvoyés dans la réponse. |
uaqi_color_palette |
Facultatif. Détermine la palette de couleurs utilisée pour les données fournies par l 'indice de qualité de l'air universel (IQA). Cette palette de couleurs ne s'applique qu'à l'IQA de l'UA. Les autres IQA ont une palette de couleurs prédéterminée qui ne peut pas être contrôlée. |
custom_local_aqis[] |
Facultatif. Indique une relation "pays/région/IQA". Associe un pays/une région à un IQA souhaité afin que les données de 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, vous pouvez obtenir l'indice 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 sur la qualité de l'air requises. Si vous ne spécifiez aucun champ lié à la période, une erreur INVALID_ARGUMENT s'affiche. La valeur de time_range ne peut être que l'une des suivantes: time_range ne peut être que l'une des valeurs suivantes: |
|
date_time |
Code temporel pour lequel renvoyer les données historiques. Le code temporel est arrondi à l'heure exacte précédente. Remarque: Cette requête renvoie uniquement les données horaires pour l'horodatage demandé (c'est-à-dire un seul élément d'informations horaires). Par exemple, une requête envoyée où 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". |
hours |
Nombre compris entre 1 et 720 qui indique la plage horaire de la requête. Par exemple, une valeur de 48 heures générera des données des 48 dernières heures. |
period |
Indique la période de début et de fin pour laquelle obtenir les données historiques. Le code temporel est arrondi à l'heure exacte précédente. |
universal_aqi |
Facultatif. Si cette valeur est définie sur "true", l'IQA universel sera inclus dans le champ "indexes" de la réponse. La valeur par défaut est "true" (vrai). |
language_code |
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 reposent sur la norme IETF. La valeur par défaut est "en". |
LookupHistoryResponse
Champs | |
---|---|
hours_info[] |
Facultatif. Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la requête porte sur 48 heures d'historique, 48 éléments d'informations horaires seront renvoyés. |
region_code |
Facultatif. Code ISO-3166-1 alpha-2 du pays/région correspondant à l'emplacement indiqué dans la requête. Ce champ peut être omis de la réponse si l'établissement indiqué dans la requête se trouve dans un territoire contesté. |
next_page_token |
Facultatif. Jeton permettant de récupérer la page suivante. |
HourInfo
Contient les informations sur la qualité de l'air pour chaque heure de la plage demandée. Par exemple, si la requête porte sur 48 heures d'historique, 48 éléments d'informations horaires seront renvoyés.
Champs | |
---|---|
date_time |
Horodatage arrondi indiquant l'heure à laquelle les données font référence au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Par exemple: "2014-10-02T15:00:00Z". |
indexes[] |
En fonction des paramètres de la requête, cette liste comprendra (jusqu'à) deux indices de qualité de l'air:
|
pollutants[] |
Liste des polluants affectant l'emplacement spécifié dans la requête. Remarque: Ce champ ne sera 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. |
health_recommendations |
Conseils de santé et actions recommandées en fonction des conditions de qualité de l'air signalées Les recommandations sont adaptées différemment pour les populations à risque, les groupes les plus sensibles aux polluants et la population générale. |
MapType
Type de la carte de densité de la qualité de l'air. Définit le polluant que la carte représentera graphiquement.
Enums | |
---|---|
MAP_TYPE_UNSPECIFIED |
Valeur par défaut. Le serveur l'ignore s'il est transmis en tant que paramètre. |
UAQI_RED_GREEN |
Palette rouge-vert de l'indice de la qualité de l'air universel. |
UAQI_INDIGO_PERSIAN |
Palette indigo-persan de l'indice de la qualité de l'air universel. |
PM25_INDIGO_PERSIAN |
Indice PM2,5 : palette indigo-persan |
GBR_DEFRA |
Palette de couleurs de l'IQA quotidien (Royaume-Uni). |
DEU_UBA |
Palette de couleurs de l'indice de la qualité de l'air local en Allemagne. |
CAN_EC |
Palette de couleurs de l'indice sanitaire de qualité de l'air au Canada. |
FRA_ATMO |
Palette de couleurs de l'indice de la qualité de l'air en France. |
US_AQI |
Palette de couleurs de l'indice de la qualité de l'air aux États-Unis. |
Polluant
Données sur un polluant de la qualité de l'air.
Champs | |
---|---|
code |
Nom de code du polluant (par exemple, "so2"). Pour obtenir la liste des codes de polluants acceptés, consultez la section Polluants signalés. |
display_name |
Nom à afficher du polluant. Exemple: "NOx". |
full_name |
Nom complet du polluant. Pour les composés chimiques, il s'agit du nom IUPAC. Exemple: "Dioxyde de soufre". Pour en savoir plus sur le tableau des noms IUPAC, consultez https://iupac.org/what-we-do/periodic-table-of-elements/. |
concentration |
Niveau de concentration du polluant mesuré à l'aide de l'une des unités de mesure standard de la pollution de l'air. |
additional_info |
Informations supplémentaires sur le polluant |
AdditionalInfo
Sources d'émission et effets sur la santé d'un polluant donné
Champs | |
---|---|
sources |
Texte représentant les principales sources d'émissions du polluant. |
effects |
Texte représentant les principaux effets sanitaires du polluant. |
Concentration
Concentration d'un polluant donné dans l'air.
Champs | |
---|---|
units |
Unités de mesure de la concentration de ce polluant. |
value |
Valeur de la concentration du polluant. |
Unité
Définit l'unité utilisée pour mesurer la concentration du polluant. Pour déterminer l'unité de concentration par défaut d'un polluant donné, consultez le tableau de la section Polluants signalés.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Unité de concentration non spécifiée. |
PARTS_PER_BILLION |
Unité de concentration en parties par milliard (ppb). |
MICROGRAMS_PER_CUBIC_METER |
Unité de concentration "µg/m^3" (microgrammes par mètre cube). |