Method: gauges.searchGaugesByArea

Pesquise indicadores por área geográfica.

Observação: os indicadores são adicionados ou removidos ocasionalmente. Por isso, o resultado dessa API não deve ser armazenado em cache ou por longos períodos. Considere que um dia é relativamente seguro.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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
}
Campos
pageSize

integer

Opcional. O número máximo de indicadores a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 50.000 indicadores serão retornados. O valor máximo é 50.000. Valores acima disso serão convertidos para 50.000.
pageToken

string

Opcional. Um token de página recebido de uma chamada SearchGauges anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para SearchGauges precisam corresponder à chamada que forneceu o token da página.

Campo de união search_by.

search_by pode ser apenas de um dos tipos a seguir:
regionCode

string

Pesquise todos os indicadores em uma região usando o código dela. Use https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Pesquise todos os indicadores em um loop (um polígono esférico simples, consulte Loop).
includeNonQualityVerified

boolean

Opcional. Inclua no resultado indicadores que não foram verificados quanto à qualidade. Use com cuidado. O padrão é false
includeGaugesWithoutHydroModel

boolean

Opcional. Incluir nos indicadores de resultado que não têm um modelo hidrológico interno do Google. O padrão é false

Corpo da resposta

A resposta de "gauges.searchGaugesByArea".

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Campos
gauges[]

object (Gauge)

Medidores encontrados na área solicitada.
nextPageToken

string

Opcional. Um token que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.