Method: providers.vehicles.search

object (RequestHeader)

عنوان طلب Fleet Engine العادي

object (TerminalLocation)

مطلوب. نقطة الاستلام التي تريد البحث بالقرب منها

object (TerminalLocation)

الموقع الجغرافي المقصود لتسليم الطلب للعميل يكون الحقل مطلوبًا إذا كان tripTypes يحتوي على TripType.SHARED.

integer

مطلوب. لتحديد نطاق البحث عن المركبات حول نقطة الاستلام لن يتم عرض سوى المركبات ضمن نطاق البحث. يجب أن تتراوح القيمة بين 400 و10,000 متر (بما في ذلك).

integer

مطلوب. تُستخدَم لتحديد الحد الأقصى لعدد المركبات التي سيتم عرضها. يجب أن تتراوح القيمة بين 1 و50 (بما في ذلك).

integer

مطلوب. تُستخدَم لتحديد عدد الركاب المُدرَجين في رحلة معيّنة. يجب أن تكون القيمة أكبر من أو تساوي واحدًا. ولا يتم احتساب قيمة السعة للسائق.

enum (TripType)

مطلوب. تمثّل نوع الرحلة المقترَحة. يجب أن يتضمّن نوعًا واحدًا فقط. لا يُسمح باستخدام UNKNOWN_TRIP_TYPE. يحصر البحث بالمركبات التي يمكنها استيفاء متطلبات نوع الرحلة هذا.

string (Duration format)

يحصر البحث بالمركبات التي أرسلت تعديلات على الموقع الجغرافي إلى Fleet Engine خلال المدة المحدّدة فقط. لا تُعتبر المركبات الثابتة التي لا تزال تُرسِل مواقعها الجغرافية قديمة. في حال عدم ضبط هذا الحقل، يستخدم الخادم القيمة التلقائية وهي خمس دقائق.

المدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".

object (VehicleType)

مطلوب. حصر البحث على المركبات التي تنتمي إلى أحد الأنواع المحدّدة يجب تحديد نوع مركبة واحد على الأقل. لا يُسمح بأنواع المركبات التي تندرج ضمن الفئة UNKNOWN.

object (VehicleAttribute)

يمكن للمتصلين إنشاء عمليات منطقية معقّدة باستخدام أيّ مجموعة من الحقول requiredAttributes وrequiredOneOfAttributes وrequiredOneOfAttributeSets.

requiredAttributes هي قائمة، ويستخدم requiredOneOfAttributes رسالة تتيح قائمة بالقوائم. يتيح الحقلان معًا إنشاء هذا التعبير:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

يحصر البحث بالمركبات التي تتضمّن السمات المحدّدة فقط. هذا الحقل هو عملية ربط/AND. يُسمح بحد أقصى 50 سمة مطلوبة. يتطابق ذلك مع الحد الأقصى المسموح به لعدد السمات المسموح به في المركبة.

object (VehicleAttributeList)

يحصر البحث في المركبات التي تتضمّن سمة واحدة على الأقل من السمات المحدّدة في كل VehicleAttributeList. ضمن كل قائمة، يجب أن تتطابق المركبة مع سمة واحدة على الأقل. هذا الحقل هو عملية نفي شمولي/أو شاملة في كل VehicleAttributeList وعملية ربط/و شاملة في مجموعة VehicleAttributeList.

object (VehicleAttributeList)

يوفّر requiredOneOfAttributeSets وظائف إضافية.

على غرار requiredOneOfAttributes، يستخدم requiredOneOfAttributeSets رسالة تتيح قائمة قوائم، ما يسمح بالتعبيرات التالية:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

يحصر البحث في المركبات التي تتضمّن جميع السمات في VehicleAttributeList فقط. ويجب أن تتطابق المركبة مع جميع السمات ضمن كل قائمة. هذا الحقل هو عملية ربط/AND في كل VehicleAttributeList وعملية نفي شامل/OR في مجموعة VehicleAttributeList.

enum (VehicleMatchOrder)

مطلوب. تُحدِّد معيار الترتيب المطلوب للنتائج.

boolean

يشير ذلك إلى ما إذا كانت المركبات التي لديها رحلة نشطة واحدة مؤهّلة لهذا البحث. لا يتم استخدام هذا الحقل إلا عندما لا يكون currentTripsPresent محدّدًا. عندما يكون الحقل currentTripsPresent غير محدّد وهذا الحقل هو false، يتم استبعاد المركبات التي تم تحديد رحلات لها من نتائج البحث. عندما يكون currentTripsPresent غير محدّد وكان هذا الحقل هو true، يمكن أن تتضمّن نتائج البحث المركبات التي لديها رحلة نشطة واحدة لها حالة ENROUTE_TO_DROPOFF. عند تحديد currentTripsPresent، لا يمكن ضبط هذا الحقل على "صحيح".

تكون القيمة التلقائية false.

string

يشير إلى الرحلة المرتبطة بهذا SearchVehicleRequest.

enum (CurrentTripsPresent)

يشير ذلك إلى ما إذا كانت المركبات التي لديها رحلات نشطة مؤهّلة لهذا البحث. يجب ضبط هذه القيمة على قيمة أخرى غير CURRENT_TRIPS_PRESENT_UNSPECIFIED إذا كانت tripType تتضمّن SHARED.

string

اختيارية: طلب بحث فلتر لتطبيقه عند البحث عن المركبات يُرجى الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر.

تم تصميم هذا الحقل ليحلّ محلّ الحقول requiredAttributes وrequiredOneOfAttributes وrequired_one_of_attributes_sets. في حال تحديد قيمة غير فارغة هنا، يجب أن تكون الحقول التالية فارغة: requiredAttributes وrequiredOneOfAttributes وrequired_one_of_attributes_sets.

يعمل هذا الفلتر كعبارة AND مع قيود أخرى، مثل minimumCapacity أو vehicleTypes.

يُرجى العِلم أنّ طلبات البحث الوحيدة المتوافقة هي تلك المتعلّقة بسمات المركبات (على سبيل المثال، attributes.<key> = <value> أو attributes.<key1> = <value1> AND attributes.<key2> = <value2>). ويبلغ الحد الأقصى لعدد القيود المسموح به في طلب البحث باستخدام الفلتر 50.

بالإضافة إلى ذلك، يتم تخزين جميع السمات كسلسلة، لذا فإنّ المقارنات الوحيدة المسموح بها للسمات هي مقارنات السلاسل. لإجراء مقارنة مع الأرقام أو القيم المنطقية، يجب وضع علامتَي اقتباس حول القيم صراحةً ليتم التعامل معها كسلسلتَين (على سبيل المثال، attributes.<key> = "10" أو attributes.<key> = "true").