Method: floodStatus.searchLatestFloodStatusByArea

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

בקשת HTTP

POST https://floodforecasting.googleapis.com/v1/floodStatus:searchLatestFloodStatusByArea

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

גוף הבקשה

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

ייצוג JSON 
{
  "cutoffTime": string,
  "pageToken": string,
  "pageSize": integer,

  // Union field area_type can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field area_type.
  "includeNonQualityVerified": boolean
}
שדות
cutoffTime

string

אופציונלי. המועד האחרון לפרסום סטטוסים לגבי שיטפונות. אם מספקים את הנתונים, יוחזרו הסטטוסים האחרונים של השיטפונות (הסטטוסים שפורסמו לאחרונה) נכון למועד האחרון. אם לא מציינים את הפרמטר הזה, המערכת תחזיר את הסטטוסים האחרונים של השיטפונות שפורסמו עד עכשיו. המועד המוקדם ביותר שאפשר להגדיר למועד האחרון הוא 2025-08-01T00:00:00Z. אם שעת הסגירה היא לפני השעה הזו, תוחזר שגיאת INVALID_ARGUMENT. הפורמט הוא ISO 8601, למשל: ‎"2025-10-17T10:34:00Z"‎.
pageToken

string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של floodStatus.searchLatestFloodStatusByArea. צריך להזין את הטוקן כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-floodStatus.searchLatestFloodStatusByArea חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
pageSize

integer

אופציונלי. מספר המצבים המקסימלי של הצפות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 20,000 סטטוסים של הצפות. הערך המקסימלי הוא 20,000. ערכים גבוהים יותר יומרו ל-20,000.

שדה איחוד area_type.

הערך area_type יכול להיות רק אחד מהבאים:
regionCode

string

האזור שרוצים לשאול לגביו על מצב השיטפון. אפשר להשתמש בקודי האזורים במאגר CLDR. לדוגמה: 'US'.
loop

object (Loop)

הלולאה שדרכה מתבצעת השאילתה לגבי סטטוסים של הצפות.
includeNonQualityVerified

boolean

אופציונלי. הכללה בתוצאה של מדדים שלא עברו אימות איכות. חשוב להשתמש בזהירות. ברירת המחדל היא False.

גוף התשובה

התשובה של floodStatus.searchLatestFloodStatusByArea.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ],
  "nextPageToken": string
}
שדות
floodStatuses[]

object (FloodStatus)

הסטטוסים האחרונים של השיטפונות באזור המבוקש. בשלב הזה, המיקום של המדדים קובע את הסדר, אבל זה עשוי להשתנות בעתיד.
nextPageToken

string

אופציונלי. טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.