الحصول على جميع DeliveryVehicle
التي تستوفي معايير الفلترة المحدّدة.
طلب HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
parent |
مطلوب. يجب أن يكون بالتنسيق |
معامِلات طلب البحث
المعلمات | |
---|---|
header |
اختياريّ. عنوان طلب واجهة برمجة التطبيقات Standard Delivery API |
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 |
مطلوب. تمثّل هذه السمة النقطة العليا لإطار العرض. |