الحصول على جميع DeliveryVehicle
التي تستوفي معايير الفلترة المحددة.
طلب HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
parent |
مطلوبة. يجب استخدام التنسيق |
معلمات طلب البحث
المَعلمات | |
---|---|
header |
اختياريّ. عنوان الطلب العادي لواجهة برمجة التطبيقات للتسليم العادي. |
pageSize |
اختياريّ. تمثّل هذه السمة الحد الأقصى لعدد المركبات المطلوب إرجاعها. وقد تعرض الخدمة عددًا أقل من هذا الرقم. وإذا لم تحدد هذا الرقم، يحدد الخادم عدد النتائج المراد عرضها. |
pageToken |
اختياريّ. رمز مميّز للصفحة تم تلقّيه من مكالمة سابقة لـ عند تقسيم النتائج على عدّة صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى |
filter |
اختياريّ. استعلام تصفية ليتم تطبيقه عند إدراج مركبات التسليم. يُرجى الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. في حال عدم تحديد قيمة أو تحديد سلسلة فارغة للفلتر، يتم عرض جميع مركبات التسليم. يُرجى العِلم أنّ طلبات البحث الوحيدة المتوافقة مع يبلغ الحد الأقصى لعدد القيود المسموح بها في طلب بحث فلتر 50. القيد هو جزء من طلب البحث بالصيغة |
viewport |
اختياريّ. فلتر يحدّ من المركبات التي يتم إرجاعها إلى المركبات التي كان آخر موقع جغرافي معروف لها في المنطقة المستطيلة التي حدّدها إطار العرض. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
رسالة الرد deliveryVehicles.list
.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"deliveryVehicles": [
{
object ( |
الحقول | |
---|---|
deliveryVehicles[] |
مجموعة مركبات التوصيل التي تستوفي معايير التصفية المطلوبة. وفي حال عدم تحديد فلتر، يعرض الطلب جميع مركبات التسليم. ويمكن أن تكون الاستجابة الناجحة فارغة أيضًا. يشير الرد الفارغ إلى أنه لم يتم العثور على مركبات توصيل تستوفي معايير التصفية المطلوبة. |
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 |
مطلوبة. النقطة العليا في إطار العرض. |