Method: gauges.searchGaugesByArea

Buscar indicadores por área geográfica

Nota: Los indicadores se agregan o quitan ocasionalmente, por lo que el resultado de esta API no se debe almacenar en caché ni guardar durante períodos prolongados. Considera que un día es relativamente seguro.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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. Es la cantidad máxima de indicadores que se devolverán. El servicio puede mostrar menos que este valor. Si no se especifica, se devolverán, como máximo, 50,000 indicadores. El valor máximo es 50,000,y los valores superiores se convertirán a 50,000.
pageToken

string

Opcional. Un token de página, recibido desde una llamada SearchGauges anterior. Proporciona esto para recuperar la página siguiente. Cuando se realiza la paginación, todos los demás parámetros proporcionados a SearchGauges deben guardar correspondencia con la llamada que proporcionó el token de la página.

Campo de unión search_by.

search_by puede ser una de las siguientes opciones:
regionCode

string

Busca todos los indicadores dentro de una región por código de región. Usa https://cldr.unicode.org/ (lista https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).
loop

object (Loop)

Busca todos los medidores dentro de un bucle (un polígono esférico simple, consulta Loop).
includeNonQualityVerified

boolean

Opcional. Incluye en los indicadores de resultados los que no se verificaron en cuanto a la calidad. Úsala con precaución. El valor predeterminado es falso.
includeGaugesWithoutHydroModel

boolean

Opcional. Se incluyen en los indicadores de resultados que no tienen un modelo hidrológico interno de Google. El valor predeterminado es falso.

Cuerpo de la respuesta

Es la respuesta de gauges.searchGaugesByArea.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
Campos
gauges[]

object (Gauge)

Son los medidores que se encuentran en el área solicitada.
nextPageToken

string

Opcional. Es un token que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.