Method: floodStatus.searchLatestFloodStatusByArea

依地理區域搜尋最新淹水狀況。注意:系統會傳回水位計位於指定區域內的洪水狀態,而非與指定區域相交的受影響區域。日後可能會有變動。

HTTP 要求

POST https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體會包含結構如下的資料:

JSON 表示法
{
  "cutoffTime": string,
  "pageToken": string,
  "pageSize": integer,

  // Union field area_type can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field area_type.
  "includeNonQualityVerified": boolean
}
欄位
cutoffTime

string

(選用步驟) (選用步驟) 洪水狀態的截止時間。如果提供這項資訊,系統會傳回截至截止時間的最新 (上次發布) 淹水狀態。如未提供,系統會傳回目前發布的最新淹水狀態。可接受的最早截止時間為 2025 年 8 月 1 日 00:00:00 (UTC)。如果截止時間早於這個時間,系統會傳回 INVALID_ARGUMENT 錯誤。以 ISO 8601 格式表示,例如 "2025-10-17T10:34:00Z".

pageToken

string

(選用步驟) 屬於接收自前一個 floodStatus.searchLatestFloodStatusByArea 呼叫的網頁權杖。提供此項目即可擷取後續網頁。進行分頁時,提供至 floodStatus.searchLatestFloodStatusByArea 的所有其他參數須與提供網頁權杖的呼叫相符。

pageSize

integer

(選用步驟) 要傳回的洪水狀態數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多將傳回 20,000 個淹水狀態。許可的最大值為 20,000;超出的數值將一律指定為 20,000。

聯集欄位 area_type

area_type 只能是下列其中一項:

regionCode

string

要查詢水災狀態的區域。使用 CLDR,例如 'US'。

loop

object (Loop)

查詢洪水狀態的迴圈。

includeNonQualityVerified

boolean

(選用步驟) 在結果量表中加入未通過品質驗證的量表。請謹慎使用。預設值為 false。

回應主體

floodStatus.searchLatestFloodStatusByArea 的回應。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ],
  "nextPageToken": string
}
欄位
floodStatuses[]

object (FloodStatus)

要求區域的最新洪水狀態。目前這項設定是根據儀表板的位置判斷,日後可能會有變動。

nextPageToken

string

(選用步驟) 可做為 pageToken 傳送的權杖,用於擷取後續網頁。如果省略這個欄位,就不會有後續頁面。