Method: gauges.searchGaugesByArea

Ölçüm cihazlarını coğrafi alana göre arama

Not: Göstergeler bazen eklenir veya kaldırılır. Bu nedenle, bu API'nin sonucu uzun süre önbelleğe alınmamalı ya da depolanmamalıdır. Bir günden uzun süre saklanan verilerin güvenli olmadığını unutmayın.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "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
}
Alanlar
pageSize

integer

İsteğe bağlı. Döndürülecek maksimum gösterge sayısı. Hizmet, bu değerden daha az sonuç döndürebilir. Belirtilmemişse en fazla 50.000 gösterge döndürülür. Maksimum değer 50.000'dir. 50.000'in üzerindeki değerler 50.000'e zorlanır.

pageToken

string

İsteğe bağlı. Önceki bir SearchGauges çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın. Sayfalara ayırma işlemi yapılırken SearchGauges öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

Birleştirme alanı search_by.

search_by yalnızca aşağıdakilerden biri olabilir:

regionCode

string

Bölge koduna göre bir bölgedeki tüm göstergeleri arayın. https://cldr.unicode.org/ adresini kullanın (https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) adresini listeleyin).

loop

object (Loop)

Bir döngüdeki tüm göstergeleri arayın (basit bir küresel poligon, bkz. Loop).

includeNonQualityVerified

boolean

İsteğe bağlı. Kalitesi doğrulanmamış sonuç göstergelerini dahil edin. Lütfen dikkatli kullanın. Varsayılan değer yanlış (false) değeridir.

includeGaugesWithoutHydroModel

boolean

İsteğe bağlı. Google'ın kendi bünyesinde hidro modeli olmayan sonuç göstergelerini dahil edin. Varsayılan değer yanlış (false) değeridir.

Yanıt gövdesi

Gauges.searchGaugesByArea'nın yanıtı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Alanlar
gauges[]

object (Gauge)

İstenen alanda bulunan ölçüm cihazları.

nextPageToken

string

İsteğe bağlı. Sonraki sayfayı almak için pageToken olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfa olmaz.