اختيار الحقول المراد إرجاعها

عند استدعاء الطريقة ComputeRoutes()، يجب تحديد الحقول التي تريد عرضها في الاستجابة. يمكنك القيام بذلك باستخدام قناع حقل الاستجابة، والذي التي تقدمها مع معلمة عنوان URL $fields أو fields، أو من خلال استخدام عنوان HTTP/gRPC X-Goog-FieldMask لمزيد من المعلومات، يُرجى الاطّلاع على مَعلمات النظام.

قناع الحقل

قيمة قناع الحقل هي قائمة مفصولة بفواصل لمسارات الحقول. كل مسار حقل عبارة عن قائمة مفصولة بالنقاط تضم أسماء الحقول التي تمثل التسلسل الهرمي للرسالة. حاسمة يكون إما مفتاح كائن JSON أو اسم علامة حقل Protobuf. تشير رسالة الأشكال البيانية من نوع رسالة الرد ذي المستوى الأعلى، ويمكن اختياريًا متبوعة بنقطة واحدة أو أكثر، ثم المستوى التالي من اسم الحقل. بشكل عام، يتم إنشاء مسارات الحقول بالطريقة التالية:

topLevelField[.secondLevelField][.thirdLevelField][...]

قناع حقل الحالة الخاصة هو حرف بدل "*"، يحدد كل مستويات الجذر الحقول.

أمثلة

يوضح المثال التالي كيفية تعيين أقنعة الحقل طريقة ComputeRoutes().

مثال 1

يجب استخدام قناع الحقل لجميع الحقول المتاحة (للفحص اليدوي).

X-Goog-FieldMask: *

مثال 2

قناع حقل للمدة والمسافة والخط المتعدّد على مستوى المسار (مثال على إعداد الإصدار العلني)

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

نحن لا ننصح باستخدام قناع حقل الاستجابة بحرف البدل (*) أو تحديد قناع الحقل في المستوى الأعلى (المسارات) في الإنتاج. يُعد تحديد الحقول التي تحتاجها:

  • تسمح لخادمنا بحفظ دورات المعالجة، والتي تتيح لنا إرجاع النتائج بوقت استجابة أقل.

  • يضمن أداء وقت الاستجابة المستقر. قد نضيف المزيد من حقول الردود في المستقبل، وقد تتطلّب هذه الحقول الجديدة وقتًا إضافيًا للمعالجة. في حال اختيار: جميع الحقول، أو إذا حددت جميع الحقول في المستوى الأعلى، فقد تواجه لأن أي حقل جديد نضيفه سيتم تلقائيًا تضمينها في ردك.

  • النتائج تكون في حجم استجابة أصغر، ما يُترجم إلى ارتفاع الشبكة سرعة معالجة البيانات.

لمزيد من المعلومات عن كيفية إنشاء مسارات الحقول، يُرجى الاطّلاع على field_mask.proto.