تعرض قائمة بالمركبات التي تتطابق مع خيارات الطلب.
طلب HTTP
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. يجب استخدام التنسيق |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "header": { object ( |
الحقول | |
---|---|
header |
عنوان الطلب العادي لـ Fleet Engine. |
pickupPoint |
مطلوبة. نقطة الاستلام للبحث بالقرب منها. |
dropoffPoint |
موقع التسليم المقصود للعميل. يجب ملء هذا الحقل إذا كان |
pickupRadiusMeters |
مطلوبة. لتحديد نصف قطر البحث عن المركبة حول نقطة الاستلام. وسيتمّ عرض المركبات ضمن نطاق البحث فقط. ويجب أن تتراوح القيمة بين 400 و10,000 متر (شاملةً). |
count |
مطلوبة. تحدّد هذه السمة الحد الأقصى لعدد المركبات المطلوب إرجاعها. يجب أن تتراوح القيمة بين 1 و50 (شاملةً). |
minimumCapacity |
مطلوبة. لتحديد عدد الركاب الذين سيتم أخذهم في الاعتبار لإجراء رحلة. يجب أن تكون القيمة أكبر من واحد أو مساوية له. لم يتم تضمين السائق في قيمة السعة. |
tripTypes[] |
مطلوبة. يمثّل هذا المقياس نوع الرحلة المقترَحة. يجب أن تتضمن نوعًا واحدًا بالضبط. لا يُسمح باستخدام |
maximumStaleness |
يقصر البحث على المركبات التي أرسلت تحديثات الموقع الجغرافي إلى Fleet Engine خلال المدة المحددة. ولا تعتبر المركبات الثابتة التي لا تزال تنقل مواقعها قديمة. وفي حال عدم ضبط هذا الحقل، سيستخدم الخادم خمس دقائق كقيمة تلقائية. مدة بالثواني مؤلفة من تسعة أرقام كسور وتنتهي بـ " |
vehicleTypes[] |
مطلوبة. تقتصر عملية البحث على المركبات التي تنتمي إلى أحد الأنواع المحدّدة. يجب تحديد نوع مركبة واحد على الأقل. لا يُسمح بأنواع المركبات من الفئة " |
requiredAttributes[] |
يمكن للمُتصلين إنشاء عمليات منطقية معقدة باستخدام أي مجموعة من الحقول
تقتصر عملية البحث على المركبات ذات السمات المحدّدة فقط. هذا الحقل هو عملية ربط/و. الحد الأقصى المسموح به لعدد السمات هو 50 سمة. تتطابق هذه السمة مع الحد الأقصى لعدد السمات المسموح بها في المركبة. |
requiredOneOfAttributes[] |
تقتصر عملية البحث على المركبات التي تتضمّن سمة واحدة على الأقل من السمات المحدّدة في كل |
requiredOneOfAttributeSets[] |
توفّر " على غرار
تقتصر عملية البحث على المركبات التي تتضمّن جميع السمات في |
orderBy |
مطلوبة. تحدد معيار الترتيب المطلوب للنتائج. |
includeBackToBack |
يشير هذا إلى ما إذا كانت المركبات التي تشمل رحلة نشطة واحدة مؤهّلة لإجراء عملية البحث هذه. ولا يتم استخدام هذا الحقل إلا في حال عدم تحديد ستكون القيمة التلقائية |
tripId |
تشير هذه السمة إلى الرحلة المرتبطة بجهاز |
currentTripsPresent |
يشير ذلك إلى ما إذا كانت المركبات ذات الرحلات النشطة مؤهَّلة لإجراء عملية البحث هذه. ويجب ضبط هذه السمة على قيمة أخرى غير |
filter |
اختياريّ. طلب فلتر لتطبيقه عند البحث عن مركبات يُرجى الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. تم تصميم هذا الحقل ليحلّ محلّ الحقول يعمل هذا الفلتر كعبارة AND مع قيود أخرى، مثل يُرجى العِلم أنّ طلبات البحث الوحيدة المسموح بها هي لسمات المركبات (على سبيل المثال، بالإضافة إلى ذلك، يتمّ تخزين جميع السمات كسلاسل، لذا فإنّ المقارنات المتاحة فقط مع السمات هي مقارنات السلاسل. للمقارنة مع القيم العددية أو المنطقية، يجب اقتباس القيم بوضوح ليتم التعامل معها كسلاسل (على سبيل المثال، |
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال SearchVehiclesResponse
.