Method: gauges.searchGaugesByArea

Telusuri indikator menurut area geografis.

Catatan: Pengukur terkadang ditambahkan atau dihapus, sehingga hasil API ini tidak boleh di-cache atau disimpan dalam jangka waktu yang lama. Pertimbangkan tidak lebih dari satu hari agar relatif aman.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi 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
}
Kolom
pageSize

integer

Opsional. Jumlah maksimum kartu yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 50.000 pengukur akan ditampilkan. Nilai maksimumnya adalah 50.000; nilai di atas 50.000 akan dikonversi menjadi 50.000.
pageToken

string

Opsional. Token halaman, diterima dari panggilan SearchGauges sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk SearchGauges harus sesuai dengan panggilan yang menyediakan token halaman.

Kolom union search_by.

search_by hanya dapat berupa salah satu dari hal berikut:
regionCode

string

Telusuri semua pengukur dalam suatu wilayah berdasarkan kode wilayah. Gunakan https://cldr.unicode.org/ (daftar https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Telusuri semua pengukur dalam loop (poligon bola sederhana, lihat Loop).
includeNonQualityVerified

boolean

Opsional. Sertakan dalam hasil alat pengukur yang tidak diverifikasi kualitasnya. Gunakan dengan hati-hati. Defaultnya adalah false.
includeGaugesWithoutHydroModel

boolean

Opsional. Sertakan dalam alat pengukur hasil yang tidak memiliki model hidro in-house Google. Defaultnya adalah false.

Isi respons

Respons gauges.searchGaugesByArea.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Kolom
gauges[]

object (Gauge)

Pengukur yang ditemukan di area yang diminta.
nextPageToken

string

Opsional. Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.