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 de 500 x 500 mètres. Comprend plus de 70 indices locaux, et l'indice et les catégories de la qualité de l'air au niveau mondial.
|
LookupForecast |
---|
Affiche les prévisions de qualité de l'air pour un lieu spécifique pendant une période donnée.
|
LookupHeatmapTile |
---|
Renvoie un tableau d'octets contenant les données de l'image PNG de tuile.
|
LookupHistory |
---|
Affiche l'historique de la qualité de l'air pour un lieu spécifique pendant une période donnée.
|
AirQualityIndex
Objet de base permettant de représenter différentes métriques de qualité de l'air. Lorsqu'elles sont regroupées, ces métriques donnent un aperçu des conditions de qualité de l'air actuelles. Il existe de nombreux indices dans le monde répondant à des objectifs différents et des groupes qui souhaitent mesurer différents aspects de la qualité de l'air.
Champs | |
---|---|
code |
Le code de l'index Ce champ représente l'index à des fins de programmation en utilisant snake case au lieu d'espaces. Exemples: "uaqi", "fra_atmo". |
display_name |
Représentation du nom de l'index dans un format lisible. Exemple: "IQA (États-Unis)" |
aqi_display |
Représentation textuelle du score numérique d'indice, pouvant inclure des symboles de préfixe ou de suffixe, qui représentent généralement la pire note d'indice. Exemple: > 100 ou 10+. Remarque: Utilisez ce champ lorsque vous souhaitez afficher le score d'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 du score numérique d'index. Par exemple: "Excellente qualité de l'air". |
dominant_pollutant |
Symbole chimique du polluant dominant. Exemple: "CO". |
aqi |
Score numérique de l'indice. Exemples: 10, 100. Cette valeur n'est pas normalisée et ne doit être interprétée que dans le contexte de l'indice de la qualité de l'air correspondant. 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 d'indice, vous devez utiliser le champ d'affichage de l'indice de qualité de l'air. |
ColorPalette
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.
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/vert doit être utilisée. |
INDIGO_PERSIAN_DARK |
Permet d'utiliser une palette indigo/persane (thème sombre). |
INDIGO_PERSIAN_LIGHT |
Permet d'utiliser une palette indigo/persane (thème clair). |
CustomLocalAqi
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.
Champs | |
---|---|
region_code |
Pays/Région dans lequel l'IQA personnalisé est nécessaire. La valeur doit être indiquée selon le code ISO 3166-1 alpha-2. |
aqi |
IQA auquel associer le pays/la région. La valeur doit être un code d'index valide. |
ExtraComputation
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.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Valeur par défaut. Le serveur l'ignore si elle est transmise en tant que paramètre. |
LOCAL_AQI |
Détermine si l'IQA local (national) du lieu demandé (pays) doit être inclus dans la réponse. Si elle est spécifiée, la réponse contiendra une structure de données "air_quality_index" avec toutes les données pertinentes sur l'IQA local de l'établissement. |
HEALTH_RECOMMENDATIONS |
Détermine si la réponse inclura les conseils de santé et les actions recommandées pour l'indice de la qualité de l'air (IQA) actuel. Ces recommandations sont adaptées à la population globale et à six groupes à risque, plus sensibles aux polluants que la population globale. S'il est spécifié, le champ |
POLLUTANT_ADDITIONAL_INFO |
Détermine si la réponse doit inclure des informations supplémentaires sur chaque polluant. S'il est spécifié, chaque objet d'indice de la qualité de l'air contenu dans la réponse du champ "index" inclut un champ |
DOMINANT_POLLUTANT_CONCENTRATION |
Détermine si la réponse inclurait les concentrations des polluants dominants mesurées en fonction d'indices mondiaux et/ou locaux. Si la demande spécifie à la fois l'IQA global et l'IQA local, jusqu'à deux codes de polluants peuvent être renvoyés. Si cet objet est spécifié, l'objet polluant dominant figurant dans la liste "polluants" sera associé à un champ |
POLLUTANT_CONCENTRATION |
Détermine si la réponse inclurait les concentrations de tous les polluants avec des mesures disponibles en fonction des indices mondiaux et/ou locaux. Si cet objet est spécifié, chaque objet polluant contenu dans le champ "Polluants" de la réponse inclut un champ |
HealthRecommendations
Recommandations de santé pour différents groupes de population dans un format texte libre. Ces recommandations sont basées sur les conditions de qualité de l'air associées.
Champs | |
---|---|
general_population |
Aucune sensibilité particulière. |
elderly |
Retraités et personnes plus âgées que la population globale. |
lung_disease_population |
Les problèmes respiratoires et l'asthme souffrent. |
heart_disease_population |
Maladies du cœur et du système circulatoire. |
athletes |
Sports et autres activités intenses en plein air. |
pregnant_women |
Les femmes à toutes les étapes 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 des conditions actuelles de qualité de l'air.
Champs | |
---|---|
location |
Obligatoire. Longitude et latitude à partir desquelles l'API recherche des données sur les conditions actuelles de qualité de l'air. |
extra_computations[] |
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. |
uaqi_color_palette |
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. |
custom_local_aqis[] |
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. |
universal_aqi |
Facultatif. Si elle est définie sur "True", l'IQA universel est inclus dans le champ "index" 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 dépendent de la norme IETF. La valeur par défaut est "en". |
LookupCurrentConditionsResponse
Champs | |
---|---|
date_time |
Code temporel arrondi au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et neuf chiffres au maximum. Par exemple: "2014-10-02T15:00:00Z". |
region_code |
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é. |
indexes[] |
En fonction des paramètres de la requête, cette liste comprendra jusqu'à deux indices de la qualité de l'air:
|
pollutants[] |
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. |
health_recommendations |
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. |
LookupForecastRequest
Objet de 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 en option Si vous spécifiez des calculs supplémentaires, les éléments et 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 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. |
custom_local_aqis[] |
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. |
page_size |
Facultatif. Nombre maximal d'enregistrements d'informations horaires à afficher par page (par défaut = 24). |
page_token |
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. |
Champ d'union time_range . Période couverte par les données de prévision de la qualité de l'air requises. La plage doit être postérieure d'au moins une heure arrondie à la date du jour. Si vous ne spécifiez pas ce champ, une erreur INVALID_ARGUMENT est générée. time_range ne peut être qu'un des éléments suivants : |
|
date_time |
Horodatage pour lequel renvoyer les données d'un moment précis. Le code temporel est arrondi à l'heure exacte précédente. Remarque: cette méthode 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 date_time est défini sur 2023-01-03T11:05:49Z sera arrondie à 2023-01-03T11:00:00Z. |
period |
Indique les périodes de début et de fin pour lesquelles vous souhaitez obtenir les données de prévision. Le code temporel est arrondi à l'heure exacte précédente. |
universal_aqi |
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). |
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 dépendent de la norme IETF (par défaut, "en"). |
LookupForecastResponse
Objet réponse de l'API de prévision de la qualité de l'air.
Champs | |
---|---|
hourly_forecasts[] |
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. |
region_code |
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é. |
next_page_token |
Facultatif. Jeton permettant de récupérer la page suivante. |
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.
Champs | |
---|---|
date_time |
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[] |
En fonction des paramètres de la requête, cette liste comprendra jusqu'à deux indices de la qualité de l'air:
|
pollutants[] |
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. |
health_recommendations |
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. |
LookupHeatmapTileRequest
Requête de tuile de carte de densité.
La structure est conforme à l'appel GET du serveur de tuiles standard, par exemple 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 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 d'affichage du contenu d'une carte dans une vue plan. Le niveau de zoom 0 représente le monde entier dans une seule tuile. Le niveau de zoom 1 correspond au monde entier réparti sur 4 tuiles. Le niveau de zoom 2 représente le monde entier en 16 tuiles. Le niveau de zoom 16 représente le monde entier divisé par 65 536 tuiles. Valeurs autorisées: de 0 à 16 |
x |
Obligatoire. Définit le point est-ouest dans la tuile demandée. |
y |
Obligatoire. Définit le point nord-sud dans la tuile demandée. |
LookupHistoryRequest
Objet de la requête de l'API d'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 72. La valeur maximale est 168 (7 jours de données). |
page_token |
Facultatif. Jeton de page reçu à partir d'un appel d'historique précédent. Il permet de récupérer la page suivante. Notez que lorsque vous attribuez une valeur à ce paramètre, tous les autres paramètres fournis doivent correspondre à l'appel qui a 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 en option Si vous spécifiez des calculs supplémentaires, les éléments et 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 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. |
custom_local_aqis[] |
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. |
Champ d'union time_range . Période couverte par les données requises sur la qualité de l'air. Si vous ne spécifiez aucun champ lié à la période, une erreur INVALID_ARGUMENT sera renvoyée. time_range ne peut être que l'un des éléments suivants: time_range ne peut être qu'un seul des éléments suivants: |
|
date_time |
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 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. Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z". |
hours |
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 |
Indique les périodes de début et de fin pour lesquelles vous souhaitez obtenir les données historiques. Le code temporel est arrondi à l'heure exacte précédente. |
universal_aqi |
Facultatif. Si elle est définie sur "True", l'IQA universel est inclus dans le champ "index" 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 dépendent de la norme IETF. La valeur par défaut est "en". |
LookupHistoryResponse
Champs | |
---|---|
hours_info[] |
Facultatif. Contient des 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, les informations horaires seront au nombre de 48. |
region_code |
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é. |
next_page_token |
Facultatif. Jeton permettant de récupérer la page suivante. |
HourInfo
Contient des 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, les informations horaires seront au nombre de 48.
Champs | |
---|---|
date_time |
Code temporel arrondi au format inférieur indiquant l'heure à laquelle les données font référence au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et neuf chiffres décimaux au maximum. Par exemple: "2014-10-02T15:00:00Z". |
indexes[] |
En fonction des paramètres de la requête, cette liste comprendra jusqu'à deux indices de la qualité de l'air:
|
pollutants[] |
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. |
health_recommendations |
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. |
MapType
Type de 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 si elle est transmise en tant que paramètre. |
UAQI_RED_GREEN |
Palette rouge-vert de l'indice universel de la qualité de l'air. |
UAQI_INDIGO_PERSIAN |
Palette indigo-persane de l'indice universel de la qualité de l'air. |
PM25_INDIGO_PERSIAN |
Palette d'indice PM2,5 indigo-perse. |
GBR_DEFRA |
Palette de couleurs de l'indice de la qualité de l'air quotidienne (Royaume-Uni). |
DEU_UBA |
Palette de couleurs de l'indice de la qualité de l'air locale en Allemagne. |
CAN_EC |
Palette de couleurs de l'indice de la 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 concernant un polluant de la qualité de l'air.
Champs | |
---|---|
code |
Le nom du code du polluant. Exemple: "so2". Pour consulter la liste complète des codes disponibles, cliquez ici. |
display_name |
Nom à afficher du polluant. Exemple: "NOx". |
full_name |
Le nom complet du polluant. Pour les composés chimiques, il s'agit du nom de l'UICPA. Exemple: "Dioxyde de soufre". Pour en savoir plus sur la table des noms de l'UICPA, consultez la page https://iupac.org/what-we-do/periodic-table-of-elements/. |
concentration |
Niveau de concentration du polluant mesuré par l'une des unités standards de mesure de la pollution atmosphérique. |
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'émission du polluant. |
effects |
Texte représentant les principaux effets du polluant sur la santé. |
Concentration
Concentration d'un polluant donné dans l'air.
Champs | |
---|---|
units |
Unités de mesure de la concentration du polluant. |
value |
Valeur de concentration du polluant. |
Unité
Définit l'unité utilisée pour mesurer la concentration du polluant.
Enums | |
---|---|
UNIT_UNSPECIFIED |
Unité de concentration non spécifiée. |
PARTS_PER_BILLION |
Unité de concentration en ppb (parties par milliard). |
MICROGRAMS_PER_CUBIC_METER |
Unité de concentration "μg/m^3" (microgrammes par mètre cube). |