Method: gauges.searchGaugesByArea

البحث عن مقاييس حسب المنطقة الجغرافية

ملاحظة: تتم إضافة المقاييس أو إزالتها أحيانًا، لذا يجب عدم تخزين نتيجة واجهة برمجة التطبيقات هذه مؤقتًا أو حفظها لفترات طويلة. يُعدّ عدم استخدامها لأكثر من يوم واحد آمنًا نسبيًا.

طلب 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 مع الطلب الذي قدّم رمز الصفحة المميز.

حقل الدمج 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 لاسترداد الصفحة التالية. في حال حذف هذا الحقل، لن تكون هناك صفحات لاحقة.