Method: providers.deliveryVehicles.list

الحصول على جميع DeliveryVehicle التي تستوفي معايير الفلترة المحددة.

طلب HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/deliveryVehicles

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
parent

string

مطلوبة. يجب استخدام التنسيق providers/{provider}. يجب أن يكون provider هو رقم تعريف مشروع Google Cloud. مثلاً: sample-cloud-project

معلمات طلب البحث

المَعلمات
header

object (DeliveryRequestHeader)

اختياريّ. عنوان الطلب العادي لواجهة برمجة التطبيقات للتسليم العادي.
pageSize

integer

اختياريّ. تمثّل هذه السمة الحد الأقصى لعدد المركبات المطلوب إرجاعها. وقد تعرض الخدمة عددًا أقل من هذا الرقم. وإذا لم تحدد هذا الرقم، يحدد الخادم عدد النتائج المراد عرضها.
pageToken

string

اختياريّ. رمز مميّز للصفحة تم تلقّيه من مكالمة سابقة لـ deliveryVehicles.list. يجب تقديم هذا المعرّف لاسترداد الصفحة التالية.

عند تقسيم النتائج على عدّة صفحات، يجب أن تتطابق جميع المَعلمات الأخرى المقدَّمة إلى deliveryVehicles.list مع الطلب الذي قدَّم الرمز المميّز للصفحة.
filter

string

اختياريّ. استعلام تصفية ليتم تطبيقه عند إدراج مركبات التسليم. يُرجى الاطّلاع على http://aip.dev/160 للحصول على أمثلة على بنية الفلتر. في حال عدم تحديد قيمة أو تحديد سلسلة فارغة للفلتر، يتم عرض جميع مركبات التسليم.

يُرجى العِلم أنّ طلبات البحث الوحيدة المتوافقة مع deliveryVehicles.list هي حول سمات المركبات (مثل attributes.<key> = <value> أو attributes.<key1> = <value1> AND attributes.<key2> = <value2>). ويتم أيضًا تخزين كل السمات كسلاسل، وبالتالي تكون المقارنات الوحيدة المتاحة مع السمات هي مقارنات السلاسل. للمقارنة مع القيم العددية أو المنطقية، يجب اقتباس القيم بوضوح ليتم التعامل معها كسلاسل (على سبيل المثال، attributes.<key> = "10" أو attributes.<key> = "true").

يبلغ الحد الأقصى لعدد القيود المسموح بها في طلب بحث فلتر 50. القيد هو جزء من طلب البحث بالصيغة attribute.<KEY> <COMPARATOR> <VALUE>، على سبيل المثال attributes.foo = bar هو قيد واحد.
viewport

object (Viewport)

اختياريّ. فلتر يحدّ من المركبات التي يتم إرجاعها إلى المركبات التي كان آخر موقع جغرافي معروف لها في المنطقة المستطيلة التي حدّدها إطار العرض.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

رسالة الرد deliveryVehicles.list.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
الحقول
deliveryVehicles[]

object (DeliveryVehicle)

مجموعة مركبات التوصيل التي تستوفي معايير التصفية المطلوبة. وفي حال عدم تحديد فلتر، يعرض الطلب جميع مركبات التسليم. ويمكن أن تكون الاستجابة الناجحة فارغة أيضًا. يشير الرد الفارغ إلى أنه لم يتم العثور على مركبات توصيل تستوفي معايير التصفية المطلوبة.
nextPageToken

string

يمكنك إدخال هذا الرمز المميّز في "ListDeliveryVehiclesRequest" للمتابعة إلى عرض النتائج. عند إرجاع جميع النتائج، لن يكون هذا الحقل في الاستجابة أو سيكون سلسلة فارغة.
totalSize

string (int64 format)

إجمالي عدد مركبات التوصيل التي تتطابق مع معايير الطلب على جميع الصفحات

إطار العرض

إطار عرض لخط العرض وخط الطول، يتم تمثيله كاثنتين قطريًا مقابل نقطتين 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
الحقول
low

object (LatLng)

مطلوبة. النقطة المنخفضة لإطار العرض.
high

object (LatLng)

مطلوبة. النقطة العليا في إطار العرض.