Package google.research.floodforecasting.v1

インデックス

FloodsApi

洪水予測用の外部 API サービス。

BatchGetGaugeModels

rpc BatchGetGaugeModels(BatchGetGaugeModelsRequest) returns (BatchGetGaugeModelsResponse)

複数のゲージの現在の水文モデル メタデータを取得します。
BatchGetGauges

rpc BatchGetGauges(BatchGetGaugesRequest) returns (BatchGetGaugesResponse)

複数のゲージに関するメタデータを取得します。
GetGauge

rpc GetGauge(GetGaugeRequest) returns (Gauge)

ゲージに関するメタデータを取得します。
GetGaugeModel

rpc GetGaugeModel(GetGaugeModelRequest) returns (GaugeModel)

特定のゲージの現在の水文モデル メタデータを取得します。
GetSerializedPolygon

rpc GetSerializedPolygon(GetSerializedPolygonRequest) returns (SerializedPolygon)

シリアル化されたポリゴンを取得します。これらの ID は他の API レスポンスに表示され、ここで使用できます。たとえば、FloodStatus の InundationMap をご覧ください。
QueryGaugeForecasts

rpc QueryGaugeForecasts(QueryGaugeForecastsRequest) returns (QueryGaugeForecastsResponse)

クエリ ゲージの予測。
QueryLatestFloodStatusByGaugeIds

rpc QueryLatestFloodStatusByGaugeIds(QueryLatestFloodStatusByGaugeIdsRequest) returns (QueryLatestFloodStatusByGaugeIdsResponse)

水位計 ID で最新の洪水状況をクエリします。
SearchGaugesByArea

rpc SearchGaugesByArea(SearchGaugesByAreaRequest) returns (SearchGaugesByAreaResponse)

地域別にゲージを検索します。

注: ゲージは随時追加または削除されるため、この API の結果をキャッシュに保存したり、長期間保存したりしないでください。1 日以内であれば比較的安全であると考えられます。
SearchLatestFloodStatusByArea

rpc SearchLatestFloodStatusByArea(SearchLatestFloodStatusByAreaRequest) returns (SearchLatestFloodStatusByAreaResponse)

地域別に最新の洪水状況を検索します。注: ゲージが指定されたエリア内にある洪水ステータスを返します。たとえば、指定されたエリアと交差する影響を受けたエリアではなく、指定されたエリア内にあるゲージの洪水ステータスを返します。これは今後変更される可能性があります。

BatchGetGaugeModelsRequest

BatchGetGaugeModels のリクエスト。

フィールド
names[]

string

必須。取得するゲージモデルの名前。名前の形式: gaugeModels/{gauge_id}。サポートされるリストのサイズは 20,000 に制限されています。20,000 を超えるリストを指定すると、INVALID_REQUEST エラーで失敗します。

BatchGetGaugeModelsResponse

BatchGetGaugeModels のレスポンス。

フィールド
gauge_models[]

GaugeModel

リクエストされたゲージモデル。

BatchGetGaugesRequest

BatchGetGauges のリクエスト。

フィールド
names[]

string

必須。取得するゲージの名前。名前の形式: gauges/{gauge_id}。サポートされるリストのサイズは 100,000 に制限されています。10 万を超えるリストを指定すると、INVALID_REQUEST エラーで失敗します。

BatchGetGaugesResponse

BatchGetGauges のレスポンス。

フィールド
gauges[]

Gauge

リクエストされたゲージ。

FloodStatus

システムによって発行された洪水ステータス。システムが予測した地域の洪水状況を表します。重大度、予測の変化、浸水マップなどの属性があります。詳しくは以下をご覧ください。

フィールド
gauge_id

string

このステータスが発行されたゲージの ID。
quality_verified

bool

この洪水ステータスが発行された水位計にモデルがない場合、またはモデルがあり、そのモデルの品質が検証されている場合は true。この値が false に設定されている場合は、注意して使用してください。
gauge_location

LatLng

このステータスが発行されたゲージの場所。
issued_time

string

このステータスが発行された時刻（文字列形式（ISO 8601））。例: "2023-06-17T10:34:00Z".
forecast_time_range

TimeRange

予測の対象となる期間。
forecast_change

ForecastChange

最後に把握された状態から予測への予測値の変化。現在は水位モデルでのみ使用できます。
forecast_trend

ForecastTrend

予測の傾向。
map_inference_type

MapInferenceType

このマップの作成に使用された推論のタイプ。
severity

Severity

ステータスの重大度。
inundation_map_set

InundationMapSet

推定された冠水マップのセット。
source

string

このゲージのデータに責任を負う組織（例: GRDC、CWC など
serialized_notification_polygon_id

string

シリアル化された通知ポリゴンの ID。Google がユーザーにアラートを送信するタイミングを判断するために使用する地理的領域を表します。GetSerializedPolygon を使用して、シリアル化されたポリゴン自体を取得します。

ForecastChange

最後に把握された状態から予測までの予測値の変化。現在は水位モデルでのみ使用できます。

フィールド
value_change

ValueChange

予測される値の変化。
reference_time_range

TimeRange

最後に確認された状態の期間。この期間から値の変化を予測します。たとえば、基準期間が昨日に設定され、値の変化が 25 ～ 30 cm に設定されている場合があります。つまり、水位の 25 ～ 30 cm の上昇は、現在の値ではなく、昨日の値と比較されます。

ValueChange

値の予測変化（上限と下限）。

フィールド
lower_bound

double

予測変更の下限（メートル単位）。変化が 20 ～ 30 の場合、この値は 20 になります。変化が -30 ～-20 の場合、この値は -30 になります。
upper_bound

double

予測変化の上限（メートル単位）。変更が 20 ～ 30 の場合、この値は 30 になります。変化が -30 ～-20 の場合、この値は -20 になります。

ForecastTrend

予測の傾向を表す列挙型。

列挙型
FORECAST_TREND_UNSPECIFIED デフォルト値。この値は使用されません。
RISE これは予測値の上昇を示します。
FALL これは、予測値の低下を示しています。
NO_CHANGE これは、予測値に変更がないことを示します。

InundationMap

1 つの氾濫マップ。

フィールド
level

InundationLevel

氾濫マップのレベル - InundationMapType に基づくドキュメントをご覧ください。
serialized_polygon_id

string

この浸水リスクマップを表すシリアル化されたポリゴンの ID。GetSerializedPolygon を使用して、シリアル化されたポリゴン自体を取得します。

InundationLevel

浸水レベルを表す列挙型。

列挙型
INUNDATION_LEVEL_UNSPECIFIED デフォルト値。この値は使用されません。
HIGH InundationMapType に基づくドキュメントをご覧ください。
MEDIUM InundationMapType に基づくドキュメントをご覧ください。
LOW InundationMapType に基づくドキュメントをご覧ください。

InundationMapSet

一連の浸水マップ。

フィールド
inundation_maps[]

InundationMap

氾濫マップ（氾濫レベルごとに 1 つ）。
inundation_maps_time_range

TimeRange

浸水マップが参照する状態の期間。
inundation_map_type

InundationMapType

氾濫マップのタイプ。

InundationMapType

浸水マップのタイプを表す列挙型。

列挙型
INUNDATION_MAP_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
PROBABILITY 確率型のマップ。InundationLevel は、地図上の洪水の確率（高、中、低）を表します。高い確率のポリゴンは中程度の確率のポリゴン内に含まれ、中程度の確率のポリゴンは低い確率のポリゴン内に含まれます。
DEPTH 型深度のマップ。InundationLevel は、地図の深さ（場所ごとの深さ: 高、中、低）を表します。深度の高いポリゴンは深度の低いポリゴンに含まれ、深度の低いポリゴンは深度の低いポリゴンに含まれます。

MapInferenceType

地図の推論の種類を表す列挙型。

列挙型
MAP_INFERENCE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
MODEL これは、この推論がモデルを使用して作成されたことを示します。
IMAGE_CLASSIFICATION これは、この推論が画像分類を使用して作成されたことを示します。

重大度

ステータスの重大度を表す列挙型。

列挙型
SEVERITY_UNSPECIFIED デフォルト値。この値は使用されません。
EXTREME これは、予測された極端なステータスを示します。
SEVERE これは、予測された重大なステータスを示します。
ABOVE_NORMAL これは、予測されたステータスが通常より高いことを示します。
NO_FLOODING これは、洪水が発生しないという予測を示しています。
UNKNOWN これは、重大度を判断するのに十分な情報がないことを示しています。

予測

複数のリードタイムに対する 1 つのゲージの予測。たとえば、発行時刻が午後 5 時の予測には、午後 6 時、午後 7 時、午後 8 時などの予測が含まれます。

注: 予測範囲の一部は、発行時刻よりも早くなる可能性があります。これは、たとえばモデルの入力データの遅延が原因で発生することがあります。上記の例では、問題の発生時刻が午後 5 時で、予測範囲が午後 4 時、午後 5 時、午後 6 時などになる可能性があります。

注: 範囲の長さと範囲間の距離は異なります。可能な範囲の例を次に示します。

  1. [5pm - 5pm]、[6pm - 6pm]、[7pm - 7pm]

  2. [3 月 1 日午前 12 時～ 3 月 2 日午前 12 時]、[3 月 2 日午前 12 時～ 3 月 3 日午前 12 時]、[3 月 3 日午前 12 時～ 3 月 4 日午前 12 時]

フィールド
forecast_ranges[]

ForecastTimedValue

予測は、さまざまな期間に関連するさまざまな予測値である複数の「予測範囲」で構成されます。範囲の開始と終了が等しい場合、それは時間の瞬間を意味します。
gauge_id

string

この予測の対象となるゲージの ID。
issued_time

string

予報の発行時刻（ISO 8601）。例: 「2023-06-17T10:34:00Z」。発行時刻は、予測が生成された時刻です。

ForecastSet

ゲージの予測のセット。

フィールド
forecasts[]

Forecast

予測。

ForecastTimedValue

期間に関連する予測値。単位は、関連付けられている GaugeModel によって定義されます。開始と終了が等しい場合は、時間インスタントを意味します。

フィールド
value

double

予測の値。
forecast_start_time

string

期間の開始。
forecast_end_time

string

間隔の終了。

ゲージ

ゲージのメタデータ。

フィールド
location

LatLng

ゲージの物理的な場所。
site_name

string

このゲージが設置されているサイトの名前（英語）。これは一意の識別子ではありません。近くの場所に同じサイト名を持つゲージが複数存在する可能性があります。常に存在するとは限りません。
source

string

このゲージのデータに責任を負う組織（GRDC、CWC など）。
river

string

水位計の川の名前（英語）。常に存在するとは限りません。
country_code

string

指標の国の国コード（ISO 3166 Alpha-2）。
gauge_id

string

ゲージの ID。
quality_verified

bool

ゲージにモデルがない場合、またはモデルがあり、そのモデルの品質が検証されている場合、このフィールドは true になります。この値が false に設定されている場合は、注意して使用してください。
has_model

bool

ゲージにモデルがある場合、このフィールドは true になります。ゲージにモデルがある場合、GetGaugeModel または BatchGetGaugeModels を使用して、このゲージの GaugeModel を取得できます。また、QueryGaugeForecasts を使用して予測を取得します。

GaugeModel

ゲージのモデルのメタデータ。

フィールド
gauge_id

string

ゲージの ID。
gauge_model_id

string

ゲージのモデルの ID。ゲージのモデルは変更されることがあります。その場合は、新しいモデルに新しい ID と新しいしきい値が割り当てられます。古い予測と新しい予測が異なるモデルで生成された場合は、比較する際に注意してください。
thresholds

Thresholds

ゲージのしきい値。
gauge_value_unit

GaugeValueUnit

ゲージモデルの値の単位。
quality_verified

bool

このモデルの品質が検証済みかどうか。この値が false に設定されている場合は、注意して使用してください。

GaugeValueUnit

ゲージ値の単位として使用できる値。

列挙型
GAUGE_VALUE_UNIT_UNSPECIFIED デフォルト値。この値は使用されません。
METERS メートル。
CUBIC_METERS_PER_SECOND 立方メートル/秒。

GetGaugeModelRequest

GetGaugeModel のリクエスト。

フィールド
name

string

必須。取得するゲージモデル名。名前の形式: gaugeModels/{gauge_id}。

GetGaugeRequest

GetGauge のリクエスト。

フィールド
name

string

必須。取得するゲージの名前。名前の形式: gauges/{gauge_id}。

GetSerializedPolygonRequest

GetSerializedPolygon のリクエスト。

フィールド
name

string

必須。取得するシリアル化されたポリゴンの名前。名前の形式: serializedPolygons/{polygon_id}

ループ

地図上のループ。単純な球面ポリゴンを表します。これは、最初の頂点が最後の頂点に暗黙的に接続されている単一の頂点チェーンで構成されます。

フィールド
vertices[]

LatLng

必須。ループの頂点。

QueryGaugeForecastsRequest

QueryGaugeForecasts のリクエスト。

フィールド
gauge_ids[]

string

必須。ゲージ ID のリスト。サポートされるリストのサイズは 500 に制限されています。500 を超えるリストを指定すると、INVALID_REQUEST エラーで失敗します。
issued_time_start

string

省略可。最も早い予測発行時刻（文字列形式（ISO 8601））。例: 「2023-06-17T10:34:00Z」、または日付文字列（「2023-10-13」など）。開始日を「2023-10-01」より前にすることはできません。デフォルトは 1 週間前です。
issued_time_end

string

省略可。最新の予報が発行された日時（ISO 8601 形式の文字列）。例: 「2023-06-17T10:34:00Z」、または日付文字列（「2023-10-13」など）。デフォルトは now です。

QueryGaugeForecastsResponse

QueryGaugeForecasts のレスポンス。

フィールド
forecasts

map<string, ForecastSet>

ゲージ ID と予測セットを対応付けるマップ。

QueryLatestFloodStatusByGaugeIdsRequest

QueryLatestFloodStatusByGaugeIds のリクエスト。

フィールド
gauge_ids[]

string

必須。ゲージ ID のリスト。サポートされるリストのサイズは 20,000 に制限されています。20,000 を超えるリストを指定すると、INVALID_REQUEST エラーで失敗します。

QueryLatestFloodStatusByGaugeIdsResponse

QueryLatestFloodStatusByGaugeIds のレスポンス。

フィールド
flood_statuses[]

FloodStatus

リクエストされたゲージの最新の洪水ステータス。

SearchGaugesByAreaRequest

SearchGaugesByArea のリクエスト。

フィールド
page_size

int32

省略可。返すゲージの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50,000 個のゲージが返されます。最大値は 50,000 です。50,000 を超える値は 50,000 に強制変換されます。
page_token

string

省略可。前回の SearchGauges 呼び出しから受け取ったページトークン。後続のページを取得するには、これを指定します。ページネーションを行う場合、SearchGauges に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

共用体フィールド search_by。

search_by は次のいずれかになります。
region_code

string

リージョン コードでリージョン内のすべてのゲージを検索します。https://cldr.unicode.org/（https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) のリスト）を使用します。
loop

Loop

ループ内のすべてのゲージを検索します（単純な球形ポリゴン。Loop を参照）。
include_non_quality_verified

bool

省略可。品質が検証されていない結果ゲージを含めます。使用する際はご注意ください。デフォルトは false です。
include_gauges_without_hydro_model

bool

省略可。Google の社内水力モデルがない結果ゲージに含めます。デフォルトは false です。

SearchGaugesByAreaResponse

SearchGaugesByArea のレスポンス。

フィールド
gauges[]

Gauge

リクエストされたエリアにあるゲージ。
next_page_token

string

省略可。次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

SearchLatestFloodStatusByAreaRequest

SearchLatestFloodStatusByArea のリクエスト。

フィールド
page_token

string

省略可。前回の SearchLatestFloodStatusByArea 呼び出しから受け取ったページトークン。後続のページを取得するには、これを指定します。ページネーションを行う場合、SearchLatestFloodStatusByArea に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。
page_size

int32

省略可。返されるフラッド ステータスの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 20,000 件の洪水ステータスが返されます。最大値は 20,000 です。20,000 を超える値は 20,000 に強制変換されます。

共用体フィールド area_type。

area_type は次のいずれかになります。
region_code

string

洪水ステータスをクエリするリージョン。CLDR を使用する（例: 'US'。
loop

Loop

フラッド ステータスをクエリするループ。
include_non_quality_verified

bool

省略可。品質が検証されていない結果ゲージを含めます。使用する際はご注意ください。デフォルトは false です。

SearchLatestFloodStatusByAreaResponse

SearchLatestFloodStatusByArea のレスポンス。

フィールド
flood_statuses[]

FloodStatus

リクエストされた地域の最新の洪水状況。現時点では、これはゲージの位置によって決まりますが、今後変更される可能性があります。
next_page_token

string

省略可。次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

SerializedPolygon

シリアル化されたポリゴン。

フィールド
polygon_id

string

ポリゴンの ID。
kml

string

ポリゴンの KML 文字列表現。

しきい値

ゲージのモデルのしきい値。

フィールド
warning_level

double

警告レベル。
danger_level

double

危険レベル。
extreme_danger_level

double

危険レベルが非常に高い。常に存在するとは限りません。

TimeRange

期間。

フィールド
start

string

期間の開始。ISO 8601 形式で表されます（例: "2023-06-17T10:34:00Z".
end

string

期間の終了。ISO 8601 形式で表されます（例: "2023-06-17T10:34:00Z".