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 سمة مطلوبة. يتطابق ذلك مع الحد الأقصى لعدد السمات المسموح به للمركبة.

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