Method: gauges.searchGaugesByArea

ค้นหาเกจวัดตามพื้นที่ทางภูมิศาสตร์

หมายเหตุ: เราอาจเพิ่มหรือนำเกจออกเป็นครั้งคราว ดังนั้นจึงไม่ควรแคชหรือจัดเก็บผลลัพธ์ของ API นี้นานเกินไป โดยพิจารณาว่าไม่เกิน 1 วันจะค่อนข้างปลอดภัย

คำขอ 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 ต้องตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ

ฟิลด์ Union 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 เพื่อดึงข้อมูลหน้าถัดไปได้ หากละเว้นช่องนี้ จะไม่มีหน้าถัดไป