البحث عن مقاييس حسب المنطقة الجغرافية
ملاحظة: تتم إضافة المقاييس أو إزالتها أحيانًا، لذا يجب عدم تخزين نتيجة واجهة برمجة التطبيقات هذه مؤقتًا أو حفظها لفترات طويلة. يُعدّ عدم استخدامها لأكثر من يوم واحد آمنًا نسبيًا.
طلب HTTP
POST https://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea
يستخدِم عنوان URL بنية تحويل الترميز gRPC.
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
الحقول | |
---|---|
pageSize |
اختياريّ. الحدّ الأقصى لعدد المقاييس المطلوب عرضها. قد تعرض الخدمة عددًا أقل من هذه القيمة. إذا لم يتم تحديدها، سيتم عرض 50,000 مقياس على الأكثر. الحد الأقصى للقيمة هو 50,000، وسيتم فرض القيمة 50,000 على القيم التي تزيد عن 50,000. |
pageToken |
اختياريّ. رمز مميز للصفحة تم تلقّيه من طلب |
حقل الدمج يمكن أن تكون |
|
regionCode |
البحث عن جميع مقاييس الأداء ضِمن منطقة معيّنة باستخدام رمز المنطقة استخدِم https://cldr.unicode.org/ (القائمة https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry). |
loop |
ابحث عن جميع أدوات القياس ضمن حلقة (مضلّع كروي بسيط، اطّلِع على |
includeNonQualityVerified |
اختياريّ. تضمين مقاييس النتائج التي لم يتم التحقّق من جودتها يُرجى استخدامه بحذر. القيمة التلقائية هي "خطأ". |
includeGaugesWithoutHydroModel |
اختياريّ. تضمين مقاييس النتائج التي لا تتضمّن نموذجًا هيدرولوجيًا داخليًا من Google القيمة التلقائية هي "خطأ". |
نص الاستجابة
استجابة gauges.searchGaugesByArea
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"gauges": [
{
object ( |
الحقول | |
---|---|
gauges[] |
مقاييس تم العثور عليها في المنطقة المطلوبة |
nextPageToken |
اختياريّ. رمز مميز يمكن إرساله كـ |