Method: gauges.searchGaugesByArea

Tìm kiếm các đồng hồ đo theo khu vực địa lý.

Lưu ý: Đôi khi, các chỉ số sẽ được thêm hoặc xoá, vì vậy, bạn không nên lưu vào bộ nhớ đệm hoặc lưu trữ kết quả của API này trong thời gian dài. Hãy cân nhắc việc không quá một ngày để tương đối an toàn.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng 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
}
Trường
pageSize

integer

Không bắt buộc. Số lượng chỉ số tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu bạn không chỉ định, thì hệ thống sẽ trả về tối đa 50.000 chỉ số. Giá trị tối đa là 50.000; các giá trị lớn hơn 50.000 sẽ được chuyển đổi thành 50.000.
pageToken

string

Không bắt buộc. Mã thông báo trang nhận được từ lệnh gọi SearchGauges trước đó. Cung cấp thông tin này để truy xuất trang tiếp theo. Khi phân trang, tất cả các tham số khác được cung cấp cho SearchGauges phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

Trường nhóm search_by.

search_by chỉ có thể là một trong những trạng thái sau:
regionCode

string

Tìm kiếm tất cả các đồng hồ đo trong một khu vực theo mã khu vực. Sử dụng https://cldr.unicode.org/ (danh sách https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Tìm kiếm tất cả các đồng hồ đo trong một vòng lặp (một đa giác hình cầu đơn giản, xem Loop).
includeNonQualityVerified

boolean

Không bắt buộc. Đưa vào những chỉ số kết quả chưa được xác minh chất lượng. Hãy thận trọng khi sử dụng. Mặc định là sai.
includeGaugesWithoutHydroModel

boolean

Không bắt buộc. Đưa vào các đồng hồ đo kết quả không có mô hình thuỷ điện nội bộ của Google. Mặc định là sai.

Nội dung phản hồi

Phản hồi của gauges.searchGaugesByArea.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Trường
gauges[]

object (Gauge)

Các đồng hồ đo được tìm thấy trong khu vực được yêu cầu.
nextPageToken

string

Không bắt buộc. Một mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang tiếp theo. Nếu bạn bỏ qua trường này, thì sẽ không có trang tiếp theo.