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

اختیاری. حداکثر تعداد سنج برای بازگشت. این سرویس ممکن است کمتر از این مقدار را بازگرداند. اگر نامشخص باشد، حداکثر 50000 گیج برگردانده می شود. حداکثر مقدار 50000 است. مقادیر بالای 50000 به 50000 اجباری می شود.

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

اختیاری. اندازه‌گیری‌هایی را که کیفیت تأیید نشده‌اند در نتایج وارد کنید. لطفا با احتیاط استفاده کنید پیش فرض نادرست است.

includeGaugesWithoutHydroModel

boolean

اختیاری. اندازه‌گیری‌هایی را در نتایج بگنجانید که مدل آبی داخلی Google ندارند. پیش فرض نادرست است.

بدن پاسخگو

پاسخ gauges.searchGaugesByArea.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "gauges": [
    {
      object (Gauge)
    }
  ],
  "nextPageToken": string
}
فیلدها
gauges[]

object ( Gauge )

سنج هایی که در منطقه درخواستی یافت می شوند.

nextPageToken

string

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