Method: floodStatus.searchLatestFloodStatusByArea

جستجوی آخرین وضعیت سیل بر اساس منطقه جغرافیایی. توجه: وضعیت سیل‌هایی را برمی‌گرداند که مقیاس آنها در منطقه داده شده قرار دارد، برخلاف مثلاً منطقه آسیب‌دیده که با منطقه داده شده تلاقی دارد. این مورد در آینده قابل تغییر است.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

نمایش 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 به 20،000 کاهش می‌یابند.

فیلد اتحادیه area_type .

area_type فقط می‌تواند یکی از موارد زیر باشد:

regionCode

string

منطقه‌ای که می‌توان وضعیت سیل را بر اساس آن جستجو کرد. با استفاده از CLDR، مثلاً «ایالات متحده».

loop

object ( Loop )

حلقه‌ای که با آن می‌توان وضعیت سیل را پرس‌وجو کرد.

includeNonQualityVerified

boolean

اختیاری. سنجه‌هایی را که کیفیتشان تأیید نشده است، در نتایج لحاظ کنید. لطفاً با احتیاط استفاده کنید. مقدار پیش‌فرض false است.

بدنه پاسخ

پاسخ floodStatus.searchLatestFloodStatusByArea.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "floodStatuses": [
    {
      object (FloodStatus)
    }
  ],
  "nextPageToken": string
}
فیلدها
floodStatuses[]

object ( FloodStatus )

آخرین وضعیت سیل در منطقه مورد درخواست. در حال حاضر، این موضوع با توجه به محل ایستگاه‌های اندازه‌گیری تعیین می‌شود و ممکن است در آینده تغییر کند.

nextPageToken

string

اختیاری. توکنی که می‌تواند به عنوان pageToken برای بازیابی صفحه بعدی ارسال شود. اگر این فیلد حذف شود، صفحات بعدی وجود نخواهند داشت.