Method: gauges.searchGaugesByArea

Wyszukiwanie wskaźników według obszaru geograficznego.

Uwaga: wskaźniki są czasami dodawane lub usuwane, więc wynik tego interfejsu API nie powinien być zapisywany w pamięci podręcznej ani przechowywany przez dłuższy czas. Za stosunkowo bezpieczny uznaj okres nie dłuższy niż jeden dzień.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis 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
}
Pola
pageSize

integer

Opcjonalnie. Maksymalna liczba zwracanych wskaźników. Usługa może zwrócić mniej niż ta wartość. Jeśli nie określono inaczej, zwracanych będzie maksymalnie 50 tys. urządzeń pomiarowych. Maksymalna wartość to 50 000. Wartości powyżej 50 000 zostaną zmienione na 50 000.
pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania SearchGauges. Podaj ten token, aby pobrać kolejną stronę. Podczas paginacji wszystkie inne parametry przekazane do funkcji SearchGauges muszą być zgodne z wywołaniem, które dostarczyło token strony.

Pole unii search_by.

Pole search_by może mieć tylko jedną z tych wartości:
regionCode

string

Wyszukaj wszystkie wodowskazy w regionie według kodu regionu. Użyj strony https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Wyszukaj wszystkie wskaźniki w pętli (prosty wielokąt sferyczny, patrz Loop).
includeNonQualityVerified

boolean

Opcjonalnie. Uwzględnij w wyniku wskaźniki, które nie zostały zweryfikowane pod kątem jakości. Używaj z rozwagą. Wartość domyślna to fałsz.
includeGaugesWithoutHydroModel

boolean

Opcjonalnie. Uwzględnij w wynikach wodowskazy, które nie mają wewnętrznego modelu hydrologicznego Google. Wartość domyślna to fałsz.

Treść odpowiedzi

Odpowiedź funkcji gauges.searchGaugesByArea.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Pola
gauges[]

object (Gauge)

Wskaźniki znalezione w żądanym obszarze.
nextPageToken

string

Opcjonalnie. Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.