Method: gauges.searchGaugesByArea

Recherchez des jauges par zone géographique.

Remarque : Des jauges sont parfois ajoutées ou supprimées. Par conséquent, le résultat de cette API ne doit pas être mis en cache ni stocké pendant de longues périodes. Une durée d'un jour maximum est considérée comme relativement sûre.

Requête HTTP

POST https://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea

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 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field search_by can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field search_by.
  "includeNonQualityVerified": boolean,
  "includeGaugesWithoutHydroModel": boolean
}
Champs
pageSize

integer

Facultatif. Nombre maximal de jauges à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 000 compteurs au maximum sont renvoyés. La valeur maximale est 50 000. Les valeurs supérieures sont réduites à 50 000.
pageToken

string

Facultatif. Jeton de page reçu d'un appel SearchGauges précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à SearchGauges doivent correspondre à l'appel ayant fourni le jeton de page.

Champ d'union search_by.

search_by ne peut être qu'un des éléments suivants :
regionCode

string

Recherchez tous les indicateurs d'une région par code régional. Utilisez https://cldr.unicode.org/ (liste https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Recherchez tous les indicateurs dans une boucle (un simple polygone sphérique, voir Loop).
includeNonQualityVerified

boolean

Facultatif. Incluez dans les résultats les jauges dont la qualité n'a pas été vérifiée. Veuillez l'utiliser avec précaution. La valeur par défaut est "false".
includeGaugesWithoutHydroModel

boolean

Facultatif. Incluez dans les jauges de résultats celles qui ne disposent pas d'un modèle hydro interne à Google. La valeur par défaut est "false".

Corps de la réponse

Réponse de gauges.searchGaugesByArea.

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

Représentation JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Champs
gauges[]

object (Gauge)

Jauges trouvées dans la zone demandée.
nextPageToken

string

Facultatif. Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.