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": { "خط العرض": 40.477398، "خط الطول": -74.259087 }, "مرتفع": { "خط العرض": 40.91618، "خط الطول": -73.70018 } }

تمثيل JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
الحقول
low

object (LatLng)

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

object (LatLng)

مطلوب. تمثّل هذه السمة النقطة العليا لإطار العرض.