Method: gauges.searchGaugesByArea

依地理區域搜尋水位計。

注意：系統偶爾會新增或移除指標，因此不應長時間快取或儲存這個 API 的結果。建議您將時間設為一天，這樣相對安全。

HTTP 要求

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

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

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "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
}
欄位
pageSize

integer

(選用步驟) 要傳回的指標數量上限。服務傳回的產品數量可能會少於這個值。如未指定，最多將傳回 50,000 個計量表。許可的最大值為 50,000；超出的數值將一律指定為 50,000。
pageToken

string

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

聯集欄位 search_by。

search_by 只能是下列其中一項：
regionCode

string

依區域代碼搜尋區域內的所有測量儀。請使用 https://cldr.unicode.org/ (清單 https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry)。
loop

object (Loop)

在迴圈中搜尋所有儀表 (簡單的球形多邊形，請參閱 Loop)。
includeNonQualityVerified

boolean

(選用步驟) 在結果量表中納入未經驗證的量表。請謹慎使用。預設值為 false。
includeGaugesWithoutHydroModel

boolean

(選用步驟) 將沒有 Google 內部水文模型的測站納入結果。預設值為 false。

回應主體

gauges.searchGaugesByArea 的回應。

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

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

object (Gauge)

要求區域中的儀表。
nextPageToken

string

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