Package google.research.floodforecasting.v1

Indeks

FloodsApi

Zewnętrzna usługa API do prognozowania powodzi.

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

Pobieranie metadanych bieżącego modelu hydrologicznego dla wielu wodowskazów.
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

Pobieranie metadanych dotyczących wielu wskaźników.
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

Pobieranie metadanych licznika.
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

Pobieranie metadanych bieżącego modelu hydrologicznego dla danego wodowskazu.
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

Uzyskiwanie zserializowanego wielokąta. Identyfikatory tych elementów będą widoczne w innych odpowiedziach interfejsu API i będziesz ich tu używać. Na przykład zobacz InundationMap w FloodStatus.
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

Zapytania o prognozy pomiarów.
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

Sprawdź najnowszy stan powodzi według identyfikatorów wskaźników.
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

Wyszukiwanie wskaźników według obszaru geograficznego.

Uwaga: wskaźniki są czasami dodawane lub usuwane, więc wynik tego interfejsu API nie powinien być zapisywany w pamięci podręcznej ani przechowywany przez dłuższy czas. Za stosunkowo bezpieczny uznaj okres nie dłuższy niż jeden dzień.
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

Wyszukaj najnowsze informacje o powodziach według obszaru geograficznego. Uwaga: zwraca stany powodzi, których wodowskaz znajduje się na danym obszarze, a nie np. obszar dotknięty powodzią, który przecina dany obszar. W przyszłości może to się zmienić.

BatchGetGaugeModelsRequest

Żądanie BatchGetGaugeModels.

Pola
names[]

string

Wymagany. Nazwy modeli wskaźników do pobrania. Format nazwy: gaugeModels/{gauge_id}. Obsługiwana wielkość listy jest ograniczona do 20 000. Jeśli lista jest większa niż 20 tys., zwracany jest błąd INVALID_REQUEST.

BatchGetGaugeModelsResponse

Odpowiedź funkcji BatchGetGaugeModels.

Pola
gauge_models[]

GaugeModel

Żądane modele wskaźników.

BatchGetGaugesRequest

Żądanie BatchGetGauges.

Pola
names[]

string

Wymagany. Nazwy wskaźników do pobrania. Format nazwy: gauges/{gauge_id}. Obsługiwana wielkość listy jest ograniczona do 100 tys. Jeśli podana lista jest większa niż 100 000,zwracany jest błąd INVALID_REQUEST.

BatchGetGaugesResponse

Odpowiedź BatchGetGauges.

Pola
gauges[]

Gauge

Żądane wskaźniki.

FloodStatus

Stan powodzi wydany przez system. Reprezentuje prognozowany przez system stan zalania danego obszaru, z atrybutami takimi jak poziom zagrożenia, zmiana prognozy, mapy zalewowe i inne. Więcej informacji znajdziesz poniżej.

Pola
gauge_id

string

Identyfikator wskaźnika, dla którego wydano ten stan.
quality_verified

bool

Wartość „true”, jeśli wodowskaz, dla którego wydano ten stan powodzi, nie ma modelu lub jeśli ma model, który został zweryfikowany pod kątem jakości. Jeśli ta wartość jest ustawiona na „false”, zachowaj ostrożność.
gauge_location

LatLng

Lokalizacja urządzenia, dla którego wydano ten stan.
issued_time

string

Czas wydania tego stanu w formie ciągu znaków (ISO 8601), np. "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

Zakres czasu, dla którego prognoza jest przewidywana.
forecast_change

ForecastChange

Zmiana wartości prognozy od ostatniego znanego stanu do prognozy. Obecnie dostępne tylko w przypadku modeli poziomu wody.
forecast_trend

ForecastTrend

Trend prognozy.
map_inference_type

MapInferenceType

Rodzaj wnioskowania, na podstawie którego utworzono tę mapę.
severity

Severity

Poziom ważności stanu.
inundation_map_set

InundationMapSet

Wnioskowany zestaw map zalania.
source

string

Organizacja odpowiedzialna za dane tego wskaźnika, np. GRDC, CWC itp.
serialized_notification_polygon_id

string

Identyfikator serializowanego wielokąta powiadomienia, który reprezentuje obszar geograficzny używany przez Google do określania, kiedy należy ostrzegać użytkowników. Użyj GetSerializedPolygon, aby uzyskać sam serializowany wielokąt.

ForecastChange

Prognozowana zmiana wartości od ostatniego znanego stanu do prognozy. Obecnie dostępne tylko w przypadku modeli poziomu wody.

Pola
value_change

ValueChange

Prognozowana zmiana wartości.
reference_time_range

TimeRange

Zakres czasu ostatniego znanego stanu, na podstawie którego przewidujemy zmianę wartości. Możemy na przykład ustawić zakres czasu odniesienia na „wczoraj” i zmianę wartości na 25–30 cm. Oznacza to, że wzrost poziomu wody o 25–30 cm jest porównywany z wartością z wczoraj, a nie z wartością obecną.

ValueChange

Prognozowana zmiana wartości – górna i dolna granica.

Pola
lower_bound

double

Dolna granica zmiany prognozy w metrach. Jeśli zmiana wynosi od 20 do 30, ta wartość będzie wynosić 20. Jeśli zmiana mieści się w przedziale od –30 do –20, ta wartość wyniesie –30.
upper_bound

double

Górna granica zmiany prognozy w metrach. Jeśli zmiana mieści się w przedziale od 20 do 30, ta wartość wyniesie 30. Jeśli zmiana mieści się w przedziale od -30 do -20, ta wartość wyniesie -20.

ForecastTrend

Wyliczenie reprezentujące trend prognozy.

Wartości w polu enum
FORECAST_TREND_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
RISE Oznacza to wzrost prognozowanej wartości.
FALL Oznacza to spadek prognozowanej wartości.
NO_CHANGE Oznacza to brak zmiany prognozowanej wartości.

InundationMap

1 mapa zalania.

Pola
level

InundationLevel

Poziom mapy zalania – zapoznaj się z dokumentacją dotyczącą typu InundationMapType.
serialized_polygon_id

string

Identyfikator serializowanego wielokąta reprezentującego tę mapę ryzyka zalania. Użyj GetSerializedPolygon, aby uzyskać sam serializowany wielokąt.

InundationLevel

Wyliczenie reprezentujące poziomy zalania.

Wartości w polu enum
INUNDATION_LEVEL_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
HIGH Zapoznaj się z dokumentacją na podstawie wartości InundationMapType.
MEDIUM Zapoznaj się z dokumentacją na podstawie wartości InundationMapType.
LOW Zapoznaj się z dokumentacją na podstawie wartości InundationMapType.

InundationMapSet

zestaw map zalewowych,

Pola
inundation_maps[]

InundationMap

Mapy zalania, po jednej dla każdego poziomu zalania.
inundation_maps_time_range

TimeRange

Zakres czasu, do którego odnoszą się mapy zalewów.
inundation_map_type

InundationMapType

Typ mapy zalania.

InundationMapType

Wyliczenie reprezentujące typ mapy zalania.

Wartości w polu enum
INUNDATION_MAP_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
PROBABILITY Mapa prawdopodobieństwa typu. InundationLevel reprezentuje prawdopodobieństwo zalania na mapie – wysokie, średnie lub niskie. Wielokąt wysokiego prawdopodobieństwa znajduje się w wielokącie średniego prawdopodobieństwa, a ten z kolei w wielokącie niskiego prawdopodobieństwa.
DEPTH Mapa głębokości typu. InundationLevel reprezentuje głębokość na mapie – dużą, średnią lub małą w zależności od lokalizacji. Wielokąt o dużej głębi znajduje się w wielokącie o średniej głębi, a ten z kolei w wielokącie o małej głębi.

MapInferenceType

Wyliczenie reprezentujące typy wniosków z mapy.

Wartości w polu enum
MAP_INFERENCE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
MODEL Oznacza to, że wnioskowanie zostało utworzone przy użyciu modelu.
IMAGE_CLASSIFICATION Oznacza to, że wnioskowanie zostało utworzone na podstawie klasyfikacji obrazu.

Poziom ważności

Wyliczenie, które reprezentuje ważność stanu.

Wartości w polu enum
SEVERITY_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
EXTREME Oznacza to prognozowany stan ekstremalny.
SEVERE Oznacza to prognozowany stan poważny.
ABOVE_NORMAL Oznacza to prognozowany stan powyżej normy.
NO_FLOODING Oznacza to prognozę braku powodzi.
UNKNOWN Oznacza to, że nie mamy wystarczających informacji, aby określić poziom ważności.

Prognoza

Prognoza dla jednego wskaźnika dla kilku czasów oczekiwania. Na przykład prognoza może być wydana o 17:00 i zawierać prognozy na 18:00, 19:00, 20:00 itd.

Uwaga: niektóre zakresy prognoz mogą być wcześniejsze niż czas wydania. Może to być spowodowane np. opóźnieniami w dostarczaniu danych wejściowych do modelu. W powyższym przykładzie czas problemu może wynosić 17:00, a przedziały prognozy to 16:00, 17:00, 18:00 itd.

Uwaga: zakresy różnią się długością i odległością między nimi. Przykłady możliwych zakresów:

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

  2. [1 marca, godz. 0:00 – 2 marca, godz. 0:00], [2 marca, godz. 0:00 – 3 marca, godz. 0:00], [3 marca, godz. 0:00 – 4 marca, godz. 0:00]

Pola
forecast_ranges[]

ForecastTimedValue

Prognoza składa się z kilku „zakresów prognozy”, czyli różnych wartości prognozy dotyczących różnych zakresów czasu. Gdy początek i koniec zakresu są równe, oznacza to, że jest to moment w czasie.
gauge_id

string

Identyfikator urządzenia pomiarowego, którego dotyczy ta prognoza.
issued_time

string

Czas wydania prognozy (ISO 8601), np. „2023-06-17T10:34:00Z”. Czas wydania to czas wygenerowania prognozy.

ForecastSet

Zestaw prognoz dla miernika.

Pola
forecasts[]

Forecast

prognozy,

ForecastTimedValue

Wartość prognozy dotycząca zakresu czasu. Jednostki są zdefiniowane przez powiązany z nią GaugeModel. Jeśli czas rozpoczęcia i zakończenia są równe, oznacza to, że jest to moment w czasie.

Pola
value

double

Wartość prognozy.
forecast_start_time

string

Początek przedziału.
forecast_end_time

string

Koniec przedziału.

Wskaźnik

Metadane miernika.

Pola
location

LatLng

Fizyczna lokalizacja urządzenia pomiarowego.
site_name

string

Nazwa witryny, w której znajduje się ten wskaźnik, w języku angielskim. Nie jest to niepowtarzalny identyfikator. W pobliskich lokalizacjach może być kilka urządzeń pomiarowych o tej samej nazwie. Nie zawsze jest obecny.
source

string

Organizacja odpowiedzialna za dane tego wskaźnika, np. GRDC, CWC itp.
river

string

Nazwa rzeki, na której znajduje się wodowskaz, w języku angielskim. Nie zawsze jest obecny.
country_code

string

Kod kraju, w którym znajduje się urządzenie pomiarowe (ISO 3166 Alpha-2).
gauge_id

string

Identyfikator miernika.
quality_verified

bool

To pole ma wartość „prawda”, jeśli wskaźnik nie ma modelu lub jeśli ma model, który został zweryfikowany pod kątem jakości. Jeśli ta wartość jest ustawiona na „false”, zachowaj ostrożność.
has_model

bool

To pole ma wartość „true”, jeśli miernik ma model. Jeśli wskaźnik ma model, można uzyskać jego GaugeModel za pomocą GetGaugeModel lub BatchGetGaugeModels. Możesz też uzyskać prognozy za pomocą funkcji QueryGaugeForecasts.

GaugeModel

Metadane modelu miernika.

Pola
gauge_id

string

Identyfikator miernika.
gauge_model_id

string

Identyfikator modelu miernika. Od czasu do czasu model wskaźnika może się zmienić. W takim przypadku przypiszemy do niego nowy identyfikator i nowe progi. Zachowaj ostrożność podczas porównywania starych i nowych prognoz, jeśli zostały one wygenerowane przez różne modele.
thresholds

Thresholds

Progi wskaźnika.
gauge_value_unit

GaugeValueUnit

Jednostka wartości modelu miernika.
quality_verified

bool

Określa, czy ten model został zweryfikowany pod kątem jakości. Jeśli ta wartość jest ustawiona na „false”, zachowaj ostrożność.

GaugeValueUnit

Możliwe jednostki wartości wskaźnika.

Wartości w polu enum
GAUGE_VALUE_UNIT_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
METERS metry,
CUBIC_METERS_PER_SECOND Metry sześcienne na sekundę.

GetGaugeModelRequest

Żądanie GetGaugeModel.

Pola
name

string

Wymagany. Nazwa modelu pomiaru do pobrania. Format nazwy: gaugeModels/{gauge_id}.

GetGaugeRequest

Żądanie GetGauge.

Pola
name

string

Wymagany. Nazwa wskaźnika do pobrania. Format nazwy: gauges/{gauge_id}.

GetSerializedPolygonRequest

Żądanie GetSerializedPolygon.

Pola
name

string

Wymagany. Nazwa serializowanego wielokąta do pobrania. Format nazwy: serializedPolygons/{polygon_id}

Zapętl

pętlę na mapie, Reprezentuje prosty wielokąt sferyczny. Składa się z jednego łańcucha wierzchołków, w którym pierwszy wierzchołek jest domyślnie połączony z ostatnim.

Pola
vertices[]

LatLng

Wymagany. Wierzchołki pętli.

QueryGaugeForecastsRequest

Żądanie QueryGaugeForecasts.

Pola
gauge_ids[]

string

Wymagany. Lista identyfikatorów mierników. Obsługiwany rozmiar listy jest ograniczony do 500. Jeśli podana lista jest większa niż 500, zwracany jest błąd INVALID_REQUEST.
issued_time_start

string

Opcjonalnie. Najwcześniejszy czas wydania prognozy w formacie ciągu znaków (ISO 8601), np. „2023-06-17T10:34:00Z” lub ciąg znaków daty, np. „2023-10-13”. Godzina rozpoczęcia nie może przypadać wcześniej niż „2023-10-01”. Domyślnie jest to tydzień temu.
issued_time_end

string

Opcjonalnie. Najnowszy czas wydania prognozy w formie ciągu znaków (ISO 8601), np. „2023-06-17T10:34:00Z” lub ciągu znaków daty, np. „2023-10-13”. Wartość domyślna to teraz.

QueryGaugeForecastsResponse

Odpowiedź funkcji QueryGaugeForecasts.

Pola
forecasts

map<string, ForecastSet>

Mapa identyfikatorów wskaźników do zestawu prognoz.

QueryLatestFloodStatusByGaugeIdsRequest

Żądanie QueryLatestFloodStatusByGaugeIds.

Pola
gauge_ids[]

string

Wymagany. Lista identyfikatorów mierników. Obsługiwana wielkość listy jest ograniczona do 20 000. Jeśli lista jest większa niż 20 tys., zwracany jest błąd INVALID_REQUEST.

QueryLatestFloodStatusByGaugeIdsResponse

Odpowiedź funkcji QueryLatestFloodStatusByGaugeIds.

Pola
flood_statuses[]

FloodStatus

Najnowsze stany powodzi dla wybranych wodowskazów.

SearchGaugesByAreaRequest

Żądanie SearchGaugesByArea.

Pola
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych wskaźników. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych będzie maksymalnie 50 tys. urządzeń pomiarowych. Maksymalna wartość to 50 000. Wartości powyżej 50 000 zostaną zmienione na 50 000.
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania SearchGauges. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wszystkie inne parametry przekazane do funkcji SearchGauges muszą być zgodne z wywołaniem, które dostarczyło token strony.

Pole unii search_by.

Pole search_by może mieć tylko jedną z tych wartości:
region_code

string

Wyszukaj wszystkie wodowskazy w regionie według kodu regionu. Użyj strony https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

Loop

Wyszukaj wszystkie wskaźniki w pętli (prosty wielokąt sferyczny, patrz Loop).
include_non_quality_verified

bool

Opcjonalnie. Uwzględnij w wyniku wskaźniki, które nie zostały zweryfikowane pod kątem jakości. Używaj z rozwagą. Wartość domyślna to fałsz.
include_gauges_without_hydro_model

bool

Opcjonalnie. Uwzględnij w wynikach wodowskazy, które nie mają wewnętrznego modelu hydrologicznego Google. Wartość domyślna to fałsz.

SearchGaugesByAreaResponse

Odpowiedź funkcji SearchGaugesByArea.

Pola
gauges[]

Gauge

Wskaźniki znalezione w żądanym obszarze.
next_page_token

string

Opcjonalnie. Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

SearchLatestFloodStatusByAreaRequest

Żądanie SearchLatestFloodStatusByArea.

Pola
page_token

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania SearchLatestFloodStatusByArea. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wszystkie inne parametry przekazane do funkcji SearchLatestFloodStatusByArea muszą być zgodne z wywołaniem, które dostarczyło token strony.
page_size

int32

Opcjonalnie. Maksymalna liczba zwracanych stanów powodzi. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 20 000 stanów powodzi. Maksymalna wartość to 20 000. Wartości powyżej 20 000 zostaną zmienione na 20 000.

Pole unii area_type.

Pole area_type może mieć tylko jedną z tych wartości:
region_code

string

Region, według którego chcesz wysyłać zapytania o stan powodzi. Korzystanie z CLDR, np. 'US'.
loop

Loop

Pętla, za pomocą której można wysyłać zapytania o stan powodzi.
include_non_quality_verified

bool

Opcjonalnie. Uwzględnij w wyniku wskaźniki, które nie zostały zweryfikowane pod kątem jakości. Używaj z rozwagą. Wartość domyślna to fałsz.

SearchLatestFloodStatusByAreaResponse

Odpowiedź funkcji SearchLatestFloodStatusByArea.

Pola
flood_statuses[]

FloodStatus

Najnowsze informacje o powodziach na wybranym obszarze. Obecnie zależy to od lokalizacji wskaźników, ale w przyszłości może się zmienić.
next_page_token

string

Opcjonalnie. Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

SerializedPolygon

Zserializowany wielokąt.

Pola
polygon_id

string

Identyfikator wielokąta.
kml

string

Ciąg tekstowy KML reprezentujący wielokąt.

Progi

Progi modelu miernika.

Pola
warning_level

double

Poziom ostrzegawczy.
danger_level

double

Poziom zagrożenia.
extreme_danger_level

double

Ekstremalny poziom zagrożenia. Nie zawsze jest obecny.

TimeRange

zakres czasu,

Pola
start

string

Początek zakresu czasu. W formacie ISO 8601, np. "2023-06-17T10:34:00Z".
end

string

Koniec zakresu czasu. W formacie ISO 8601, np. "2023-06-17T10:34:00Z".