Method: gauges.searchGaugesByArea

Поиск датчиков по географическому региону.

Примечание: датчики время от времени добавляются и удаляются, поэтому результаты этого API не следует кэшировать или хранить в течение длительного времени. Для относительной безопасности рекомендуется хранить данные не более суток.

HTTP-запрос

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

URL использует синтаксис перекодировки 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 для получения следующей страницы. Если это поле пропущено, последующих страниц не будет.