- طلب HTTP
- مَعلمات المسار
- نص الطلب
- نص الاستجابة
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- نقطة الطريق
- VehicleMatchType
تعرض قائمة بالمركبات التي تتطابق مع خيارات الطلب.
طلب 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 مع قيود أخرى، مثل يُرجى العلم أنّ طلبات البحث المتاحة فقط تتعلّق بسمات المركبات (على سبيل المثال، ويتم أيضًا تخزين جميع السمات كسلاسل، وبالتالي فإنّ المقارنات الوحيدة المسموح بها مع السمات هي مقارنات السلاسل. للمقارنة مع القيم الرقمية أو المنطقية، يجب اقتباس القيم بشكل صريح ليتم التعامل معها كسلاسل (على سبيل المثال، |
نص الاستجابة
رسالة رد واحدة (vehicles.search
).
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"matches": [
{
object ( |
الحقول | |
---|---|
matches[] |
قائمة المركبات التي تستوفي معايير |
VehicleAttributeList
تمثّل هذه السمة نوع بيانات قائمة بقوائم لسمات المركبات.
تمثيل JSON |
---|
{
"attributes": [
{
object ( |
الحقول | |
---|---|
attributes[] |
قائمة بالسمات في هذه المجموعة. |
VehicleMatchOrder
تُستخدَم لتحديد ترتيب مطابقة المركبة في الردّ.
عمليات التعداد | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
الخيار التلقائي، يُستخدم لتطابق مركبة غير محدّدة أو غير معروفة مع الطلب. |
PICKUP_POINT_ETA |
ترتيب تصاعدي حسب وقت قيادة المركبة إلى نقطة الاستلام |
PICKUP_POINT_DISTANCE |
ترتيب تصاعدي حسب المسافة التي تقودها المركبة إلى نقطة الاستلام |
DROPOFF_POINT_ETA |
ترتيب تصاعدي حسب مدة قيادة المركبة إلى نقطة التسليم. لا يمكن استخدام هذا الطلب إلا إذا تم تحديد نقطة التسليم في الطلب. |
PICKUP_POINT_STRAIGHT_DISTANCE |
ترتيب تصاعدي حسب مسافة خط مستقيم من آخر موقع جغرافي للمركبة تم الإبلاغ عنه إلى نقطة الاستلام |
COST |
ترتيب تصاعدي حسب تكلفة المطابقة التي تم ضبطها. تُعرف تكلفة المطابقة بأنها عملية حسابية مُرجحة بين مسافة الخط المستقيم والوقت المقدر للوصول. يتم تحديد القيم التقديرية بالقيم التلقائية ويمكن تعديلها لكل عميل. يُرجى التواصل مع فريق الدعم في Google إذا احتجت إلى تعديل هذه القيم التقديرية لمشروعك. |
CurrentTripsPresent
تحدّد هذه السمة أنواع القيود المفروضة على الرحلات الحالية للمركبة.
عمليات التعداد | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
يخضع توفّر المركبات التي تشمل رحلات للحقل "includeBackToBack ". |
NONE |
يمكن أن تظهر المركبات التي لا تتضمّن رحلات في نتائج البحث. عند استخدام هذه القيمة، لا يمكن أن يكون includeBackToBack true . |
ANY |
يتم تضمين المركبات التي تشمل 5 رحلات حالية و10 نقاط مسار كحد أقصى في نتائج البحث. عند استخدام هذه القيمة، لا يمكن أن يكون includeBackToBack true . |
VehicleMatch
تحتوي على المركبة والتقديرات ذات الصلة لمركبة تطابق نقاط الرحلات النشطة للمركبة "SearchVehiclesRequest
".
تمثيل JSON |
---|
{ "vehicle": { object ( |
الحقول | |
---|---|
vehicle |
مطلوب. مركبة تطابق الطلب |
vehiclePickupEta |
الوقت المقدَّر لقيادة المركبة في نقطة الاستلام المحدّدة في الطلب تشير القيمة الفارغة إلى تعذُّر احتساب الوقت المقدّر للوصول للمركبة. إذا كانت قيمة طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
vehiclePickupDistanceMeters |
المسافة من الموقع الجغرافي الحالي للمركبة إلى نقطة الاستلام المحدّدة في الطلب، بما في ذلك أي نقاط متوسطة للاستلام أو التسليم للرحلات الحالية وتضم هذه المسافة مسافة القيادة (المسارات) المحسوبة، بالإضافة إلى مسافة الخط المستقيم بين نقطة نهاية التنقل ونقطة الاستلام المطلوبة. (عادةً ما تكون المسافة بين نقطة نهاية التنقل ونقطة الاستلام المطلوبة صغيرة). تشير القيمة الفارغة إلى وجود خطأ في حساب المسافة. |
vehiclePickupStraightLineDistanceMeters |
مطلوب. المسافة المستقيمة بين المركبة ونقطة الاستلام المحدّدة في الطلب. |
vehicleDropoffEta |
الوقت المقدَّر لقيادة المركبة بالكامل عند الوصول إلى نقطة التسليم المحدّدة في الطلب ويشمل الوقت المقدر للوصول التوقف عند أي نقاط طريق قبل طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
vehiclePickupToDropoffDistanceMeters |
المسافة القيادة للمركبة (بالأمتار) من نقطة الاستلام إلى نقطة التسليم المحدّدة في الطلب تكون المسافة بين النقطتين فقط ولا تشمل الموقع الجغرافي للمركبة أو أي نقاط أخرى يجب زيارتها قبل أن تزور المركبة نقطة الركوب أو نقطة التسليم. لن تتم تعبئة القيمة إلا عند تحديد |
tripType |
مطلوب. نوع رحلة الطلب الذي تم استخدامه لاحتساب الوقت المقدّر للوصول إلى نقطة الاستلام |
vehicleTripsWaypoints[] |
القائمة المرتبة لنقاط الطريق المستخدمة لحساب الوقت المقدر للوصول. تشمل القائمة الموقع الجغرافي للمركبة ونقاط الاستلام للرحلات النشطة الخاصة بالمركبة ونقاط الاستلام الواردة في الطلب. تشير القائمة الفارغة إلى تعذُّر احتساب الوقت المقدّر للوصول للمركبة. |
vehicleMatchType |
تمثّل هذه السمة نوع المركبة المطابقة. |
requestedOrderedBy |
تمثّل هذه السمة الطلب الذي تم طلبه لترتيب المركبات المتطابقة. |
orderedBy |
الطلب الفعلي الذي تم استخدامه لهذه المركبة. عادةً ما يتطابق هذا مع ترتيب "orderBy" من الطلب؛ ولكن في بعض الحالات مثل الخطأ الداخلي في الخادم، قد يتم استخدام طريقة مختلفة (مثل |
النقطة الوسيطة
يصف هذا المقياس النقاط المتوسطة على طول مسار VehicleMatch
في SearchVehiclesResponse
. ويتم تمثيل هذا المفهوم على أنّه TripWaypoint
في جميع نقاط النهاية الأخرى.
تمثيل JSON |
---|
{
"latLng": {
object ( |
الحقول | |
---|---|
latLng |
موقع هذه النقطة. |
eta |
الوقت المقدَّر لوصول المركبة إلى هذه النقطة. طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
VehicleMatchType
تمثّل هذه السمة نوع التطابق بين المركبة.
عمليات التعداد | |
---|---|
UNKNOWN |
نوع مطابقة مركبة غير معروف |
EXCLUSIVE |
ما مِن رحلة مخصصة للمركبة حاليًا ويمكنها المتابعة إلى نقطة الاستلام. |
BACK_TO_BACK |
المركبة مخصّصة حاليًا لرحلة، ولكن يمكنها المتابعة إلى نقطة الركوب بعد إكمال الرحلة الجارية. وتراعي حسابات الوقت المقدّر للوصول والمسافة الرحلة الحالية. |
CARPOOL |
تتّسع المركبة للرحلة المشتركة. |
CARPOOL_BACK_TO_BACK |
ستُنهي المركبة رحلتها الحالية النشطة قبل المتابعة إلى نقطة الاستلام. وتراعي حسابات الوقت المقدّر للوصول والمسافة الرحلة الحالية. |