تعرض قائمة مقسّمة للمركبات المرتبطة بمقدّم خدمة يطابق خيارات الطلب.
طلب 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 |
مطلوب. تمثّل هذه السمة النقطة العليا لإطار العرض. |