Method: gauges.searchGaugesByArea

Nach Messgeräten nach geografischem Gebiet suchen

Hinweis: Messwerte werden gelegentlich hinzugefügt oder entfernt. Das Ergebnis dieser API sollte daher nicht über einen längeren Zeitraum hinweg im Cache gespeichert oder aufbewahrt werden. Ein Tag gilt als relativ sicher.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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
}
Felder
pageSize

integer

Optional. Die maximale Anzahl der zurückzugebenden Messgeräte. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Falls nicht angegeben, werden maximal 50.000 Messgeräte zurückgegeben. Der Höchstwert beträgt 50.000. Werte über 50.000 werden implizit auf 50.000 umgewandelt.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen SearchGauges-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für SearchGauges bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

Union-Feld search_by.

Für search_by ist nur einer der folgenden Werte zulässig:
regionCode

string

Mit dem Regionscode können Sie nach allen Messstationen in einer Region suchen. Verwenden Sie https://cldr.unicode.org/ (Liste https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Suchen Sie nach allen Messinstrumenten innerhalb einer Schleife (ein einfaches sphärisches Polygon, siehe Loop).
includeNonQualityVerified

boolean

Optional. Messgeräte einschließen, die nicht qualitätsgeprüft sind. Bitte mit Vorsicht verwenden. Der Standardwert ist "false".
includeGaugesWithoutHydroModel

boolean

Optional. Messgeräte in die Ergebnisse einbeziehen, für die kein internes Google-Wassermodell verfügbar ist. Der Standardwert ist "false".

Antworttext

Die Antwort von gauges.searchGaugesByArea.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Felder
gauges[]

object (Gauge)

Messgeräte im angeforderten Bereich.
nextPageToken

string

Optional. Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.