Method: forecast.lookup

Renvoie jusqu'à cinq jours d'informations quotidiennes sur le pollen dans plus de 65 pays, avec une résolution maximale de 1 km.

Requête HTTP

GET https://pollen.googleapis.com/v1/forecast:lookup

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
location

object (LatLng)

Obligatoire. Longitude et latitude à partir desquelles l'API recherche des données de prévision sur le pollen.
days

integer

Obligatoire. Nombre indiquant le nombre de jours de prévision à demander (valeur minimale 1, valeur maximale 5).
pageSize

integer

Facultatif. Nombre maximal d'enregistrements d'informations quotidiens à renvoyer par page. La valeur par défaut et maximale est de 5, ce qui indique 5 jours de données.
pageToken

string

Facultatif. Jeton de page reçu d'un appel quotidien précédent. Elle permet de récupérer la page suivante.

Notez que lorsque vous indiquez une valeur pour le jeton de page, tous les autres paramètres de demande fournis doivent correspondre à l'appel précédent qui a fourni le jeton de page.
languageCode

string

Facultatif. Permet au client de choisir la langue de la réponse. Si les données ne peuvent pas être fournies pour cette langue, l'API utilise la correspondance la plus proche. Les valeurs autorisées sont basées sur la norme IETF BCP-47. La valeur par défaut est "en".
plantsDescription

boolean

Facultatif. Contient des informations générales sur les plantes, y compris des détails sur leur saisonnalité, des formes et couleurs spéciales, des informations sur les réactions allergiques croisées et des photos de plantes. La valeur par défaut est "true".

Corps de la requête

Le corps de la requête doit être vide.

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 
{
  "regionCode": string,
  "dailyInfo": [
    {
      object (DayInfo)
    }
  ],
  "nextPageToken": string
}
Champs
regionCode

string

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é.
dailyInfo[]

object (DayInfo)

Obligatoire. Cet objet contient les informations de prévisions quotidiennes pour chaque jour demandé.
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.

LatLng

Objet représentant une paire latitude/longitude. Elle est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

DayInfo

Cet objet contient les informations de prévisions quotidiennes pour chaque jour demandé.

Représentation JSON 
{
  "date": {
    object (Date)
  },
  "pollenTypeInfo": [
    {
      object (PollenTypeInfo)
    }
  ],
  "plantInfo": [
    {
      object (PlantInfo)
    }
  ]
}
Champs
date

object (Date)

Date (UTC) à laquelle les données de prévision sur le pollen sont représentées.
pollenTypeInfo[]

object (PollenTypeInfo)

Cette liste inclura jusqu'à trois types de pollens (GRASS, WEED et TREE) affectant la zone géographique spécifiée dans la requête.
plantInfo[]

object (PlantInfo)

Cette liste inclura jusqu'à 15 espèces de pollens affectant le lieu spécifié dans la requête.

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date est donnée selon le calendrier grégorien. Il peut s'agir de l'un des éléments suivants:

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • une année seule, avec un mois et un jour zéro.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés:

Représentation JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Champs
year

integer

Année de la date. Doit être comprise entre 1 et 9999, ou 0 pour indiquer une date sans année.
month

integer

Mois de l'année. La valeur doit être comprise entre 1 et 12, ou égale à 0 pour spécifier une année sans mois ni jour.
day

integer

Jour du mois. Doit être compris entre 1 et 31, et valide pour l'année et le mois, ou 0 pour indiquer une année seule, ou une année et un mois où le jour n'est pas significatif.

PollenTypeInfo

Cet objet contient l'index de type de pollen et des informations sur les recommandations de santé concernant un type de pollen spécifique.

Représentation JSON 
{
  "code": enum (PollenType),
  "displayName": string,
  "indexInfo": {
    object (IndexInfo)
  },
  "healthRecommendations": [
    string
  ],
  "inSeason": boolean
}
Champs
code

enum (PollenType)

Nom de code du type de pollen. Exemple : "GRAS"
displayName

string

Représentation lisible du nom du type de pollen. Exemple : "Gras"
indexInfo

object (IndexInfo)

Contient les données UPI (Universal Pollen Index) pour le type de pollen.
healthRecommendations[]

string

Liste textuelle d'explications liées à des informations sur la santé basées sur les niveaux actuels de pollen.
inSeason

boolean

Indique si la plante est de saison ou non.

PollenType

Code de type de pollen

Enums
POLLEN_TYPE_UNSPECIFIED Type de plante non spécifié.
GRASS Type de pollen de gazon.
TREE Type de pollen d'arbre.
WEED Type de pollen de mauvaise herbe.

IndexInfo

Cet objet contient des données représentant une valeur, une catégorie et une description spécifiques d'indice pollinique.

Représentation JSON 
{
  "code": enum (Index),
  "displayName": string,
  "category": string,
  "indexDescription": string,
  "color": {
    object (Color)
  },
  "value": integer
}
Champs
code

enum (Index)

Code de l'index. Ce champ représente l'index à des fins de programmation, en utilisant des cas snake au lieu d'espaces. Exemple : "UPI".
displayName

string

Représentation lisible du nom de l'index. Exemple : "Indice universel de pollen".
category

string

Classification de texte de l'interprétation du score numérique d'index. Il comprend six catégories:

  • 0 : "Aucune"
  • 1: "Très faible"
  • 2: "Faible"
  • 3 : "Modérée"
  • 4 : "Élevé"
  • 5 : "Très élevé
indexDescription

string

Explication textuelle du niveau d'index actuel.
color

object (Color)

Couleur utilisée pour représenter le score numérique de l'indice de pollen.
value

integer

Score numérique de l'indice. La plage numérique est comprise entre 0 et 5.

Index

Code d'index

Enums
INDEX_UNSPECIFIED Index non spécifié.
UPI Indice universel du pollen.

Couleur

Représente une couleur dans l'espace colorimétrique RVBA. Cette représentation est conçue pour simplifier la conversion vers et depuis des représentations de couleurs dans différentes langues plutôt que pour être compacte. Par exemple, les champs de cette représentation peuvent être fournis facilement au constructeur de java.awt.Color en Java. il peut également être fourni de manière triviale à la méthode +colorWithRed:green:blue:alpha d'UIColor dans iOS. Avec un minimum d'efforts, vous pouvez facilement mettre en forme le code en une chaîne CSS rgba() en JavaScript.

Cette page de référence ne contient pas d'informations sur l'espace colorimétrique absolu à utiliser pour interpréter la valeur RVB (sRVB, Adobe RVB, DCI-P3 et BT.2020, par exemple). Par défaut, les applications doivent supposer que l'espace colorimétrique sRVB est utilisé.

Lorsque l'égalité des couleurs doit être décidée, les implémentations, sauf indication contraire, traitent deux couleurs comme égales si toutes leurs valeurs rouge, vert, bleu et alpha diffèrent de 1e-5 au maximum.

Exemple (Java) :

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

Exemple (iOS/Obj-C) :

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

Exemple (JavaScript) :

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
Représentation JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
Champs
red

number

Quantité de rouge dans la couleur en tant que valeur dans l'intervalle [0, 1].
green

number

Quantité de vert dans la couleur en tant que valeur dans l'intervalle [0, 1].
blue

number

Quantité de bleu dans la couleur en tant que valeur dans l'intervalle [0, 1].
alpha

number

Fraction de cette couleur à appliquer au pixel. En d'autres termes, la couleur finale du pixel est définie par l'équation :

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

Cela signifie qu'une valeur de 1,0 correspond à une couleur solide, tandis qu'une valeur de 0,0 correspond à une couleur complètement transparente. Un message wrapper est utilisé à la place d'une simple valeur scalaire flottante afin qu'il soit possible de distinguer une valeur par défaut de la valeur non définie. S'il est omis, cet objet couleur est affiché sous la forme d'une couleur unie (comme si la valeur alpha avait été explicitement définie sur 1,0).

PlantInfo

Cet objet contient les informations quotidiennes sur une plante spécifique.

Représentation JSON 
{
  "code": enum (Plant),
  "displayName": string,
  "indexInfo": {
    object (IndexInfo)
  },
  "plantDescription": {
    object (PlantDescription)
  },
  "inSeason": boolean
}
Champs
code

enum (Plant)

Nom de code de la plante. Exemple : "COTTONWOOD". La liste de tous les codes disponibles est disponible ici.
displayName

string

Représentation lisible du nom de la plante. Exemple : "Cottonwood".
indexInfo

object (IndexInfo)

Cet objet contient des données représentant une valeur, une catégorie et une description spécifiques d'indice pollinique.
plantDescription

object (PlantDescription)

Contient des informations générales sur les plantes, y compris des détails sur leur saisonnalité, des formes et couleurs spéciales, des informations sur les réactions allergiques croisées et des photos de plantes.
inSeason

boolean

Indique si la plante est de saison ou non.

Plante

Répertorie les plantes disponibles dont la disponibilité varie selon les emplacements.

Enums
PLANT_UNSPECIFIED Code végétal non spécifié.
ALDER L'aulne est classé dans la catégorie des pollens d'arbres.
ASH Les frênes sont classées dans la catégorie des pollens d'arbres.
BIRCH Le bouleau est classé dans la catégorie de pollen d'arbre.
COTTONWOOD Le bois de peuplier est classé comme pollen d'arbre.
ELM L'orme est classé comme un type de pollen d'arbre.
MAPLE L'érable est classé dans la catégorie des pollens d'arbres.
OLIVE Le pollen d'olivier est classé dans la catégorie des pollens d'arbres.
JUNIPER Le genévrier est classé dans la catégorie des pollens d'arbres.
OAK Le chêne est classé comme pollen d'arbre.
PINE Le pin est classé dans la catégorie des pollens d'arbres.
CYPRESS_PINE Le pin cyprès est classé dans la catégorie de pollen d'arbre.
HAZEL Le noisetier est classé dans la catégorie de pollen d'arbre.
GRAMINALES Les graminées sont classées dans la catégorie des pollens d'herbe.
RAGWEED L'ambroisie est classée dans la catégorie des pollens de mauvaise herbe.
MUGWORT L'armoise appartient à la catégorie des pollens d'herbes aromatiques.

PlantDescription

Contient des informations générales sur les plantes, y compris des détails sur leur saisonnalité, des formes et couleurs spéciales, des informations sur les réactions allergiques croisées et des photos de plantes.

Représentation JSON 
{
  "type": enum (PollenType),
  "family": string,
  "season": string,
  "specialColors": string,
  "specialShapes": string,
  "crossReaction": string,
  "picture": string,
  "pictureCloseup": string
}
Champs
type

enum (PollenType)

Type de pollen de la plante. Exemple : "GRASS". La liste de tous les codes disponibles est disponible ici.
family

string

Représentation lisible du nom de la famille de plantes. Exemple : "Bétulacées (famille des bouleaux)".
season

string

Liste textuelle d'explications des saisons où le pollen est actif. Exemple : "Fin de l'hiver, printemps".
specialColors

string

Description textuelle des plantes des couleurs de feuilles, d'écorces, de fleurs ou de graines permettant d'identifier la plante.
specialShapes

string

Description textuelle des plantes formes de feuilles, d'écorces, de fleurs ou de graines permettant d'identifier la plante.
crossReaction

string

Description textuelle de plantes à réaction croisée pollinique. Exemples: Pollen d'aulne, de noisetier, de charme, de hêtre, de saule et de chêne.
picture

string

Lien vers l'image de la plante.
pictureCloseup

string

Lien vers une photo en gros plan de la plante.