Package google.research.floodforecasting.v1

Index

FloodsApi

Ein externer API-Dienst für die Hochwasservorhersage.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Rufen Sie die aktuellen Metadaten des hydrologischen Modells für mehrere Messstellen ab.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Metadaten zu mehreren Messgeräten abrufen.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Metadaten zu einem Messgerät abrufen.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Rufen Sie die aktuellen Metadaten des hydrologischen Modells für einen bestimmten Messpunkt ab.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Ein serialisiertes Polygon abrufen. Die IDs für diese werden in anderen API-Antworten angezeigt und können hier verwendet werden. Ein Beispiel finden Sie unter InundationMap in FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Prognosen für Messgeräte abfragen.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Aktuellen Hochwasserstatus nach Messstellen-IDs abfragen.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

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.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Suchen Sie nach dem aktuellen Hochwasserstatus nach geografischem Gebiet. Hinweis: Gibt Hochwasserstatus zurück, deren gauge sich im angegebenen Bereich befindet, im Gegensatz z.B. zu betroffenen Gebieten, die sich mit dem angegebenen Bereich überschneiden. Dies kann sich in Zukunft ändern.

BatchGetGaugeModelsRequest

Die Anfrage von BatchGetGaugeModels.

Felder
names[]

string

Erforderlich. Die Namen der abzurufenden Messmodell. Namensformat: gaugeModels/{gauge_id}. Die unterstützte Listengröße ist auf 20.000 Einträge begrenzt. Wenn eine Liste mit mehr als 20.000 Elementen angegeben wird,schlägt der Vorgang mit dem Fehler INVALID_REQUEST fehl.

BatchGetGaugeModelsResponse

Die Antwort von BatchGetGaugeModels.

Felder
gauge_models[]

GaugeModel

Die angeforderten Messgeräte-Modelle.

BatchGetGaugesRequest

Die Anfrage von BatchGetGauges.

Felder
names[]

string

Erforderlich. Die Namen der abzurufenden Messgeräte. Namensformat: „gauges/{gauge_id}“. Die unterstützte Listengröße ist auf 100.000 Einträge begrenzt. Wenn eine Liste mit mehr als 100.000 Elementen angegeben wird,schlägt der Vorgang mit dem Fehler INVALID_REQUEST fehl.

BatchGetGaugesResponse

Die Antwort von BatchGetGauges.

Felder
gauges[]

Gauge

Die angeforderten Messgeräte.

FloodStatus

Ein vom System ausgegebener Hochwasserstatus. Gibt den vom System prognostizierten Überflutungsstatus für ein Gebiet an, mit Attributen wie Schweregrad, Prognoseänderung und Überflutungskarten. Weitere Details finden Sie unten.

Felder
gauge_id

string

Die ID des Messgeräts, für das dieser Status ausgestellt wurde.
quality_verified

bool

„True“, wenn für den Pegel, für den dieser Hochwasserstatus ausgegeben wurde, kein Modell vorhanden ist oder wenn ein Modell vorhanden ist und die Qualität des Modells überprüft wurde. Seien Sie vorsichtig, wenn dieser Wert auf „false“ gesetzt ist.
gauge_location

LatLng

Der Standort des Messgeräts, für das dieser Status ausgestellt wurde.
issued_time

string

Die Uhrzeit, zu der dieser Status ausgestellt wurde, als String (ISO 8601), z.B. "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Der Zeitraum, für den die Prognose erstellt wird.
forecast_change

ForecastChange

Die Änderung des Prognosewerts vom letzten bekannten Status zur Prognose. Derzeit nur für Modelle für den Wasserstand verfügbar.
forecast_trend

ForecastTrend

Der Trend der Prognose.
map_inference_type

MapInferenceType

Die Art der Inferenz, mit der diese Karte erstellt wurde.
severity

Severity

Der Schweregrad des Status.
inundation_map_set

InundationMapSet

Die abgeleitete Gruppe von Überschwemmungskarten.
source

string

Die für die Daten dieses Messgeräts verantwortliche Organisation, z.B. GRDC, CWC usw.
serialized_notification_polygon_id

string

Eine ID des serialisierten Benachrichtigungs-Polygons, das den geografischen Bereich darstellt, den Google verwendet, um zu bestimmen, wann Nutzer benachrichtigt werden sollen. Verwenden Sie GetSerializedPolygon, um das serialisierte Polygon abzurufen.

ForecastChange

Die prognostizierte Wertänderung vom letzten bekannten Status bis zur Prognose. Derzeit nur für Modelle für den Wasserstand verfügbar.

Felder
value_change

ValueChange

Die prognostizierte Änderung der Werte.
reference_time_range

TimeRange

Zeitbereich des letzten bekannten Status, aus dem die Wertänderung prognostiziert wird. Beispielsweise kann der Referenzzeitraum auf „Gestern“ und die Wertänderung auf 25–30 cm festgelegt sein. Das bedeutet, dass der Anstieg des Wasserstands um 25–30 cm mit dem Wert von gestern verglichen wird, nicht mit dem aktuellen Wert.

ValueChange

Die prognostizierte Änderung der Werte – eine Ober- und eine Untergrenze.

Felder
lower_bound

double

Die Untergrenze der Prognoseänderung in Metern. Wenn die Änderung zwischen 20 und 30 liegt, ist dieser Wert 20. Wenn die Änderung zwischen -30 und -20 liegt, wäre dieser Wert -30.
upper_bound

double

Die Obergrenze der Prognoseänderung in Metern. Wenn die Änderung zwischen 20 und 30 liegt, ist dieser Wert 30. Wenn die Änderung zwischen -30 und -20 liegt, ist dieser Wert -20.

ForecastTrend

Ein Enum-Wert, der den Trend der Prognose darstellt.

Enums
FORECAST_TREND_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
RISE Das bedeutet, dass der prognostizierte Wert gestiegen ist.
FALL Das bedeutet, dass der prognostizierte Wert gesunken ist.
NO_CHANGE Das bedeutet, dass sich der prognostizierte Wert nicht ändert.

InundationMap

Eine Überschwemmungskarte.

Felder
level

InundationLevel

Die Ebene der Überschwemmungskarte. Weitere Informationen finden Sie in der Dokumentation zu InundationMapType.
serialized_polygon_id

string

Eine ID des serialisierten Polygons, das diese Karte zum Überschwemmungsrisiko darstellt. Verwenden Sie GetSerializedPolygon, um das serialisierte Polygon abzurufen.

InundationLevel

Ein Enum-Wert, der die Überschwemmungspegel darstellt.

Enums
INUNDATION_LEVEL_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
HIGH Weitere Informationen finden Sie in der Dokumentation zum InundationMapType.
MEDIUM Weitere Informationen finden Sie in der Dokumentation zum InundationMapType.
LOW Weitere Informationen finden Sie in der Dokumentation zum InundationMapType.

InundationMapSet

Eine Reihe von Überschwemmungskarten.

Felder
inundation_maps[]

InundationMap

Die Überschwemmungskarten, eine für jede Überschwemmungsstufe.
inundation_maps_time_range

TimeRange

Der Zeitraum des Zustands, auf den sich die Überschwemmungskarten beziehen.
inundation_map_type

InundationMapType

Der Typ der Überschwemmungskarte.

InundationMapType

Ein Enum-Wert, der den Typ der Überschwemmungskarte darstellt.

Enums
INUNDATION_MAP_TYPE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
PROBABILITY Eine Karte vom Typ „Wahrscheinlichkeit“. „InundationLevel“ steht für die Wahrscheinlichkeit einer Überschwemmung auf der Karte (hoch, mittel, niedrig). Das Polygon mit hoher Wahrscheinlichkeit ist im Polygon mit mittlerer Wahrscheinlichkeit enthalten und das Polygon mit mittlerer Wahrscheinlichkeit ist im Polygon mit niedriger Wahrscheinlichkeit enthalten.
DEPTH Eine Karte vom Typ „Tiefe“ „InundationLevel“ gibt die Kartentiefe an – hoch, mittel oder niedrig – für jeden Standort. Das Polygon mit hoher Tiefe ist im Polygon mit mittlerer Tiefe enthalten und das Polygon mit mittlerer Tiefe ist im Polygon mit geringer Tiefe enthalten.

MapInferenceType

Ein Enum, das die Typen von Karteninferenzen darstellt.

Enums
MAP_INFERENCE_TYPE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
MODEL Das bedeutet, dass diese Inferenz mit einem Modell erstellt wurde.
IMAGE_CLASSIFICATION Das bedeutet, dass diese Inferenz mithilfe einer Bildklassifizierung erstellt wurde.

Schweregrad

Ein Enum-Wert, der den Schweregrad des Status darstellt.

Enums
SEVERITY_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
EXTREME Dies weist auf einen prognostizierten extremen Status hin.
SEVERE Dies weist auf einen prognostizierten schwerwiegenden Status hin.
ABOVE_NORMAL Dies weist auf einen prognostizierten Status über dem Normalwert hin.
NO_FLOODING Das bedeutet, dass kein Hochwasser vorhergesagt wird.
UNKNOWN Das bedeutet, dass wir nicht genügend Informationen haben, um den Schweregrad zu bestimmen.

Prognose

Die Prognose für einen einzelnen Messpunkt für mehrere Vorlaufzeiten. Eine Prognose kann beispielsweise um 17:00 Uhr erstellt werden und Prognosen für 18:00, 19:00, 20:00 Uhr usw. enthalten.

Hinweis: Einige der Prognosebereiche können potenziell früher als der Ausstellungszeitpunkt liegen. Das kann beispielsweise an Verzögerungen bei den Eingabedaten für das Modell liegen. Im obigen Beispiel könnte die Uhrzeit des Problems 17:00 Uhr sein und die Prognosebereiche für 16:00 Uhr, 17:00 Uhr, 18:00 Uhr usw.

Hinweis: Die Bereiche variieren in Länge und Abstand zueinander. Hier einige Beispiele für mögliche Bereiche:

  1. [17:00–17:00], [18:00–18:00], [19:00–19:00]

  2. [1. März, 00:00 Uhr – 2. März, 00:00 Uhr], [2. März, 00:00 Uhr – 3. März, 00:00 Uhr], [3. März, 00:00 Uhr – 4. März, 00:00 Uhr]

Felder
forecast_ranges[]

ForecastTimedValue

Eine Prognose besteht aus mehreren „Prognosebereichen“, die unterschiedliche Prognosewerte für unterschiedliche Zeiträume enthalten. Wenn Start und Ende eines Bereichs gleich sind, handelt es sich um einen Zeitpunkt.
gauge_id

string

Die ID des Messgeräts, für das diese Prognose erstellt wurde.
issued_time

string

Die Ausstellungszeit des Vorhersagezeitraums (ISO 8601), z.B. „2023-06-17T10:34:00Z“. Der Zeitpunkt, zu dem die Prognose erstellt wurde.

ForecastSet

Eine Reihe von Prognosen für ein Messgerät.

Felder
forecasts[]

Forecast

Die Prognosen.

ForecastTimedValue

Ein Prognosewert für einen Zeitraum. Die Einheiten werden durch das zugehörige GaugeModel definiert. Wenn Start und Ende gleich sind, handelt es sich um einen Zeitpunkt.

Felder
value

double

Der Wert der Prognose.
forecast_start_time

string

Der Beginn des Intervalls.
forecast_end_time

string

Das Ende des Intervalls.

Gauge

Metadaten einer Anzeige.

Felder
location

LatLng

Der physische Standort des Messgeräts.
site_name

string

Der Name der Website, auf der sich dieses Messgerät befindet, auf Englisch. Dies ist keine eindeutige Kennung. Es kann mehrere Messgeräte an Standorten in der Nähe mit demselben Websitenamen geben. Nicht immer vorhanden.
source

string

Die für die Daten dieses Messgeräts verantwortliche Organisation, z.B. GRDC, CWC usw.
river

string

Der Name des Flusses in Englisch. Nicht immer vorhanden.
country_code

string

Der Ländercode des Landes des Messgeräts (ISO 3166 Alpha-2).
gauge_id

string

Die ID des Messgeräts.
quality_verified

bool

Dieses Feld ist „true“, wenn für das Messgerät kein Modell vorhanden ist oder wenn ein Modell vorhanden ist und die Qualität des Modells überprüft wurde. Seien Sie vorsichtig, wenn dieser Wert auf „false“ gesetzt ist.
has_model

bool

Dieses Feld ist „true“, wenn das Messgerät ein Modell hat. Wenn das Messgerät ein Modell hat, kann die GaugeModel des Messgeräts mit GetGaugeModel oder BatchGetGaugeModels abgerufen werden. Außerdem werden die Prognosen mit QueryGaugeForecasts abgerufen.

GaugeModel

Metadaten des Modells eines Messgeräts.

Felder
gauge_id

string

Die ID des Messgeräts.
gauge_model_id

string

Die ID des Modells des Messinstruments. Das Modell für ein Messinstrument kann sich von Zeit zu Zeit ändern. In diesem Fall weisen wir dem neuen Modell eine neue ID und neue Grenzwerte zu. Seien Sie vorsichtig, wenn Sie alte und neue Prognosen vergleichen, die mit unterschiedlichen Modellen erstellt wurden.
thresholds

Thresholds

Die Schwellenwerte des Messgeräts.
gauge_value_unit

GaugeValueUnit

Die Werteinheit des Modells des Messinstruments.
quality_verified

bool

Gibt an, ob dieses Modell qualitätsgeprüft ist. Seien Sie vorsichtig, wenn dieser Wert auf „false“ gesetzt ist.

GaugeValueUnit

Mögliche Einheiten für den Messwert.

Enums
GAUGE_VALUE_UNIT_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
METERS Meter
CUBIC_METERS_PER_SECOND Kubikmeter pro Sekunde.

GetGaugeModelRequest

Die Anfrage von GetGaugeModel.

Felder
name

string

Erforderlich. Der Name des abzurufenden Messinstrumentmodells. Namensformat: gaugeModels/{gauge_id}.

GetGaugeRequest

Die Anfrage von GetGauge.

Felder
name

string

Erforderlich. Der Name des abzurufenden Messgeräts. Namensformat: „gauges/{gauge_id}“.

GetSerializedPolygonRequest

Die Anfrage von GetSerializedPolygon.

Felder
name

string

Erforderlich. Der Name des abzurufenden serialisierten Polygons. Namensformat: serializedPolygons/{polygon_id}

Schleife

Eine Schleife auf der Karte. Stellt ein einfaches sphärisches Polygon dar. Sie besteht aus einer einzelnen Kette von Eckpunkten, wobei der erste Eckpunkt implizit mit dem letzten verbunden ist.

Felder
vertices[]

LatLng

Erforderlich. Die Eckpunkte der Schleife.

QueryGaugeForecastsRequest

Die Anfrage von „QueryGaugeForecasts“.

Felder
gauge_ids[]

string

Erforderlich. Eine Liste von Mess-IDs. Die unterstützte Listengröße ist auf 500 Einträge begrenzt. Wenn eine Liste mit mehr als 500 Elementen angegeben wird, schlägt der Vorgang mit dem Fehler INVALID_REQUEST fehl.
issued_time_start

string

Optional. Die früheste Prognosezeit als String (ISO 8601), z.B. „2023-06-17T10:34:00Z“ oder ein Datumsstring, z.B. „2023-10-13“. Die Startzeit darf nicht vor dem 01.10.2023 liegen. Die Standardeinstellung ist vor einer Woche.
issued_time_end

string

Optional. Die Uhrzeit der letzten Prognose als String (ISO 8601), z.B. „2023-06-17T10:34:00Z“ oder ein Datumsstring, z.B. „2023-10-13“. Der Standardwert ist „Jetzt“.

QueryGaugeForecastsResponse

Die Antwort von QueryGaugeForecasts.

Felder
forecasts

map<string, ForecastSet>

Eine Zuordnung von Messgeräte-IDs zu Prognosesets.

QueryLatestFloodStatusByGaugeIdsRequest

Die Anfrage von QueryLatestFloodStatusByGaugeIds.

Felder
gauge_ids[]

string

Erforderlich. Eine Liste von Mess-IDs. Die unterstützte Listengröße ist auf 20.000 Einträge begrenzt. Wenn eine Liste mit mehr als 20.000 Elementen angegeben wird,schlägt der Vorgang mit dem Fehler INVALID_REQUEST fehl.

QueryLatestFloodStatusByGaugeIdsResponse

Die Antwort von QueryLatestFloodStatusByGaugeIds.

Felder
flood_statuses[]

FloodStatus

Die aktuellen Hochwasserstände für die angeforderten Messstellen.

SearchGaugesByAreaRequest

Die Anfrage von SearchGaugesByArea.

Felder
page_size

int32

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.
page_token

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:
region_code

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

Loop

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

bool

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

bool

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

SearchGaugesByAreaResponse

Die Antwort von SearchGaugesByArea.

Felder
gauges[]

Gauge

Messgeräte im angeforderten Bereich.
next_page_token

string

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

SearchLatestFloodStatusByAreaRequest

Die Anfrage von SearchLatestFloodStatusByArea.

Felder
page_token

string

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

int32

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

Union-Feld area_type.

Für area_type ist nur einer der folgenden Werte zulässig:
region_code

string

Die Region, nach der der Hochwasserstatus abgefragt werden soll. Verwenden Sie CLDR, z.B. 'US'.
loop

Loop

Die Schleife, mit der Hochwasserstatus abgefragt werden sollen.
include_non_quality_verified

bool

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

SearchLatestFloodStatusByAreaResponse

Die Antwort von SearchLatestFloodStatusByArea.

Felder
flood_statuses[]

FloodStatus

Die aktuellen Hochwasserstände im angeforderten Gebiet. Derzeit wird dies durch den Standort der Messgeräte bestimmt. Das kann sich in Zukunft ändern.
next_page_token

string

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

SerializedPolygon

Ein serialisiertes Polygon.

Felder
polygon_id

string

Die ID des Polygons.
kml

string

Die KML-Stringdarstellung des Polygons.

Grenzwerte

Schwellenwerte des Modells einer Anzeige.

Felder
warning_level

double

Warnstufe
danger_level

double

Gefahrenstufe.
extreme_danger_level

double

Extremes Gefahrenniveau. Nicht immer vorhanden.

TimeRange

Ein Zeitraum.

Felder
start

string

Der Beginn des Zeitraums. Dargestellt als ISO 8601, z.B. "2023-06-17T10:34:00Z".
end

string

Das Ende des Zeitraums. Dargestellt als ISO 8601, z.B. "2023-06-17T10:34:00Z".