Method: gauges.searchGaugesByArea

Cerca indicatori per area geografica.

Nota: gli indicatori vengono aggiunti o rimossi di tanto in tanto, pertanto il risultato di questa API non deve essere memorizzato nella cache o archiviato per lunghi periodi di tempo. Considera un periodo non superiore a un giorno come relativamente sicuro.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
pageSize

integer

(Facoltativo) Il numero massimo di indicatori da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 50.000 indicatori. Il valore massimo è 50.000; i valori superiori a 50.000 verranno forzati a 50.000.

pageToken

string

(Facoltativo) Un token di pagina ricevuto da una precedente chiamata SearchGauges. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a SearchGauges devono corrispondere alla chiamata che ha fornito il token di pagina.

Campo unione search_by.

search_by può essere solo uno dei seguenti:

regionCode

string

Cerca tutti gli indicatori all'interno di una regione in base al codice regione. Utilizza https://cldr.unicode.org/ (elenco https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).

loop

object (Loop)

Cerca tutti gli indicatori all'interno di un loop (un semplice poligono sferico, vedi Loop).

includeNonQualityVerified

boolean

(Facoltativo) Includi nei grafici dei risultati quelli non verificati in termini di qualità. Utilizzalo con cautela. Il valore predefinito è false.

includeGaugesWithoutHydroModel

boolean

(Facoltativo) Includi nei misuratori dei risultati quelli che non hanno un modello idrico interno di Google. Il valore predefinito è false.

Corpo della risposta

La risposta di gauges.searchGaugesByArea.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Campi
gauges[]

object (Gauge)

Indicatori trovati nell'area richiesta.

nextPageToken

string

(Facoltativo) Un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.