Method: providers.vehicles.search

{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}

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
...)

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

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 فقط. يجب أن تتطابق المركبة مع جميع السمات في كل قائمة. هذا الحقل هو عملية ربط/و في كل VehicleAttributeList وعملية فاصلة/أو شاملة في مجموعة 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").