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": { "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)

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