Method: providers.vehicles.list

تعرض قائمة مقسّمة للمركبات المرتبطة بمقدّم خدمة يطابق خيارات الطلب.

طلب HTTP

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

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

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

المعلمات
parent

string

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

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

المعلمات
header

object (RequestHeader)

عنوان طلب Fleet Engine العادي.

pageSize

integer

تمثّل هذه السمة الحدّ الأقصى لعدد المركبات المطلوب إرجاعها. القيمة التلقائية: 100.

pageToken

string

قيمة nextPageToken التي يوفرها استدعاء سابق إلى vehicles.list حتى يكون بإمكانك التقسيم على صفحات بين مجموعات من المركبات. تكون القيمة غير محدّدة إذا لم تكن معايير الفلتر للطلب هي نفسها معايير الفلتر لطلب vehicles.list السابق.

minimumCapacity

integer

تحدّد هذه السمة الحدّ الأدنى المطلوب لسعة المركبة. سيكون لكل المركبات التي تم إرجاعها maximumCapacity أكبر من أو تساوي هذه القيمة. وفي حال ضبطها، يجب أن تكون القيمة أكبر من 0 أو مساوية له.

tripTypes[]

enum (TripType)

يحدّ من الاستجابة للمركبات التي تتوافق مع نوع واحد على الأقل من أنواع الرحلات المحدّدة.

maximumStaleness

string (Duration format)

لتقييد الاستجابة للمركبات التي أرسلت تعديلات الموقع الجغرافي إلى Fleet Engine خلال المدة المحدّدة. ولا تُعتبر المركبات الثابتة التي لا تزال تنقل مواقعها قديمة. في حال توفُّرها، يجب أن تكون مدة موجبة صالحة.

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام "s" مثال: "3.5s"

vehicleTypeCategories[]

enum (Category)

مطلوب. تحصر الاستجابة للمركبات ذات إحدى الفئات المحدّدة. لا يُسمح باستخدام UNKNOWN.

requiredAttributes[]

string

ويمكن للمتصلين إنشاء عمليات منطقية معقدة باستخدام أي مجموعة من الحقول requiredAttributes وrequiredOneOfAttributes وrequiredOneOfAttributeSets.

requiredAttributes قائمة. يستخدم requiredOneOfAttributes رسالة تسمح بقائمة من القوائم. ويسمح الحقلان معًا بتكوين هذا التعبير:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

تحصر الاستجابة للمركبات ذات السمات المحدّدة. هذا الحقل هو عملية ربط/و. لا يمكن اختيار 50 سمة مطلوبة كحدّ أقصى. يتطابق ذلك مع الحد الأقصى لعدد السمات المسموح بها في المركبة. يجب أن تكون كل سلسلة متكررة بالتنسيق "key:value".

requiredOneOfAttributes[]

string

تعمل هذه السياسة على تقييد الاستجابة للمركبات التي تتضمّن سمة واحدة على الأقل من السمات المحدّدة في كل VehicleAttributeList. وفي كل قائمة، يجب أن تتطابق المركبة مع سمة واحدة على الأقل. يمثّل هذا الحقل عملية فصل/أو عملية شاملة في كل VehicleAttributeList وعملية ضم/و في مجموعة VehicleAttributeList. يجب أن تكون كل سلسلة متكررة بالتنسيق "key1:value1|key2:value2|key3:value3".

requiredOneOfAttributeSets[]

string

يوفّر requiredOneOfAttributeSets وظائف إضافية.

على غرار requiredOneOfAttributes، يستخدم requiredOneOfAttributeSets رسالة تسمح بقائمة من القوائم، مع السماح بالتعبيرات مثل هذه:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

الردّ على المركبات التي تتطابق مع جميع السمات في VehicleAttributeList ويجب أن تتطابق المركبة مع جميع السمات في كل قائمة. هذا الحقل هو عملية ربط/و في كل عملية VehicleAttributeList وعملية فصل/أو عملية شاملة على مستوى مجموعة VehicleAttributeList. يجب أن تكون كل سلسلة متكررة بالتنسيق "key1:value1|key2:value2|key3:value3".

vehicleState

enum (VehicleState)

لتقييد الاستجابة للمركبات التي تحمل حالة المركبة هذه.

onTripOnly

boolean

إرجاع المركبات ذات الرحلات الحالية فقط

filter

string

اختياريّ. عبارة عن طلب بحث للفلترة يتم تطبيقه عند إدراج المركبات. راجِع http://aip.dev/160 للاطّلاع على أمثلة عن بنية الفلاتر.

تم تصميم هذا الحقل ليحلّ محلّ الحقول requiredAttributes وrequiredOneOfAttributes وrequired_one_of_attributes_sets. إذا تم تحديد قيمة غير فارغة هنا، يجب أن تكون الحقول التالية فارغة: requiredAttributes وrequiredOneOfAttributes وrequired_one_of_attributes_sets.

يعمل هذا الفلتر كعبارة AND مع قيود أخرى، مثل vehicleState أو onTripOnly.

يُرجى العلم أنّ طلبات البحث المتاحة فقط تتعلّق بسمات المركبات (على سبيل المثال، attributes.<key> = <value> أو attributes.<key1> = <value1> AND attributes.<key2> = <value2>). الحد الأقصى لعدد القيود المسموح بها في طلب بحث الفلتر هو 50.

ويتم أيضًا تخزين جميع السمات كسلاسل، وبالتالي فإنّ المقارنات الوحيدة المسموح بها مع السمات هي مقارنات السلاسل. للمقارنة مع القيم الرقمية أو المنطقية، يجب اقتباس القيم بشكل صريح ليتم التعامل معها كسلاسل (على سبيل المثال، attributes.<key> = "10" أو attributes.<key> = "true").

viewport

object (Viewport)

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

نص الطلب

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

نص الاستجابة

رسالة رد واحدة (vehicles.list).

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

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

object (Vehicle)

المركبات التي تتطابق مع المعايير الواردة في الطلب يحدّد الحقل pageSize في الطلب الحدّ الأقصى لعدد المركبات التي تم إرجاعها.

nextPageToken

string

رمز مميّز لاسترداد الصفحة التالية من المركبات أو فارغًا إذا لم يكن هناك مركبات أخرى تستوفي معايير الطلب

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)

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