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)

اختياريّ. عنوان طلب واجهة برمجة التطبيقات Standard Delivery API
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)

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