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 的值会强制转换为 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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。