Method: gauges.searchGaugesByArea

חיפוש מדדים לפי אזור גיאוגרפי.

הערה: מדי פעם מתווספים או מוסרים מדדים, ולכן לא מומלץ לשמור את התוצאה של ה-API הזה במטמון או לאחסן אותה לפרקי זמן ארוכים. מומלץ להגדיר את התקופה הזו ליום אחד לכל היותר.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-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.
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 כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.