Method: gauges.searchGaugesByArea

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

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

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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 を超える値は 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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。