تعرض قائمة بالمركبات مقسّمة على صفحات والمرتبطة بمقدّم خدمة يتطابق مع خيارات الطلب.
طلب HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. يجب استخدام التنسيق |
معلمات طلب البحث
المَعلمات | |
---|---|
header |
عنوان الطلب العادي لـ Fleet Engine. |
pageSize |
تمثّل هذه السمة الحد الأقصى لعدد المركبات المطلوب إرجاعها. القيمة التلقائية: 100. |
pageToken |
قيمة |
minimumCapacity |
تحدّد هذه السمة الحدّ الأدنى لسعة المركبة. وستكون قيمة |
tripTypes[] |
تقتصر الاستجابة على المركبات التي تتيح نوعًا واحدًا على الأقل من أنواع الرحلات المحدّدة. |
maximumStaleness |
لتقييد الاستجابة للمركبات التي أرسلت تحديثات الموقع الجغرافي إلى Fleet Engine خلال المدة المحددة. ولا تعتبر المركبات الثابتة التي لا تزال تنقل مواقعها قديمة. وفي حال توفّر هذه القيمة، يجب أن تكون مدة موجبة صالحة. مدة بالثواني مؤلفة من تسعة أرقام كسور وتنتهي بـ " |
vehicleTypeCategories[] |
مطلوبة. يحصر هذا الخيار الاستجابة للمركبات ذات إحدى فئات الأنواع المحدّدة. لا يُسمح باستخدام |
requiredAttributes[] |
يمكن للمُتصلين إنشاء عمليات منطقية معقدة باستخدام أي مجموعة من الحقول
تحظر الاستجابة للمركبات ذات السمات المحدّدة. هذا الحقل هو عملية ربط/و. الحد الأقصى المسموح به لعدد السمات هو 50 سمة. تتطابق هذه السمة مع الحد الأقصى لعدد السمات المسموح بها في المركبة. يجب أن تكون كل سلسلة متكررة بالتنسيق "key:value". |
requiredOneOfAttributes[] |
تفرض الاستجابة على المركبات ذات سمة واحدة على الأقل من السمات المحدّدة في كل |
requiredOneOfAttributeSets[] |
توفّر " على غرار
تعمل هذه السياسة على حصر الاستجابة للمركبات التي تتطابق مع جميع السمات في |
vehicleState |
لتقييد الاستجابة للمركبات التي تحمل حالة المركبة هذه. |
onTripOnly |
إرجاع المركبات التي تحمل الرحلات الحالية فقط |
filter |
اختياريّ. طلب فلتر لتطبيقه عند إدراج المركبات يُرجى الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. تم تصميم هذا الحقل ليحلّ محلّ الحقول يعمل هذا الفلتر كعبارة AND مع قيود أخرى، مثل يُرجى العِلم أنّ طلبات البحث الوحيدة المسموح بها هي لسمات المركبات (على سبيل المثال، بالإضافة إلى ذلك، يتمّ تخزين جميع السمات كسلاسل، لذا فإنّ المقارنات المتاحة فقط مع السمات هي مقارنات السلاسل. للمقارنة مع القيم العددية أو المنطقية، يجب اقتباس القيم بوضوح ليتم التعامل معها كسلاسل (على سبيل المثال، |
viewport |
اختياريّ. فلتر يحدّ من المركبات التي يتم إرجاعها إلى المركبات التي كان آخر موقع جغرافي معروف لها في المنطقة المستطيلة التي حدّدها إطار العرض. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة رد واحدة (vehicles.list
)
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"vehicles": [
{
object ( |
الحقول | |
---|---|
vehicles[] |
مركبات تُطابق المعايير الواردة في الطلب. يتمّ تحديد الحدّ الأقصى لعدد المركبات التي يتم إرجاعها من خلال الحقل |
nextPageToken |
رمز مميّز لاسترداد الصفحة التالية من المركبات، أو يكون فارغًا إذا لم تتوفّر مركبات أخرى تستوفي معايير الطلب |
totalSize |
مطلوبة. إجمالي عدد المركبات التي تتطابق مع معايير الطلب في جميع الصفحات |
إطار العرض
إطار عرض لخط العرض وخط الطول، يتم تمثيله كاثنتين قطريًا مقابل نقطتين low
وhigh
. ويعتبر إطار العرض منطقة مغلقة، أي أنه يشمل حدودها. يجب أن تتراوح حدود خطوط العرض بين -90 و90 درجة شاملة، ويجب أن تتراوح حدود خط الطول بين -180 و180 درجة شاملة. تشمل الحالات المختلفة ما يلي:
إذا كانت
low
=high
، يتكوّن إطار العرض من هذه النقطة الواحدة.إذا كانت القيمة
low.longitude
>high.longitude
، سيتم عكس نطاق خط الطول (يتجاوز إطار العرض خط الطول البالغ 180 درجة).إذا كانت درجة
low.longitude
= -180 درجة وhigh.longitude
= 180 درجة، سيتضمّن إطار العرض جميع خطوط الطول.إذا كانت درجة الحرارة
low.longitude
= 180 درجة وhigh.longitude
= -180 درجة، يكون نطاق خط الطول فارغًا.إذا كانت قيمة
low.latitude
>high.latitude
، يكون نطاق خط العرض فارغًا.
يجب تعبئة كل من low
وhigh
، ولا يمكن أن يكون المربع الممثل فارغًا (كما هو محدد في التعريفات أعلاه). سيؤدي إطار العرض الفارغ إلى حدوث خطأ.
على سبيل المثال، يحتوي إطار العرض هذا على مدينة نيويورك بالكامل:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
تمثيل JSON |
---|
{ "low": { object ( |
الحقول | |
---|---|
low |
مطلوبة. النقطة المنخفضة لإطار العرض. |
high |
مطلوبة. النقطة العليا في إطار العرض. |