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으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.