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. يجب أن تكون كل سلسلة متكرّرة بالتنسيق "المفتاح1:القيمة1|المفتاح2:القيمة2|المفتاح3:القيمة3".
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، ولا يمكن أن يكون المربّع الذي يتم تمثيله فارغًا (كما هو محدَّد في التعريفات أعلاه). سيؤدي استخدام مساحة عرض فارغة إلى حدوث خطأ.

على سبيل المثال، تحيط إطار العرض هذا بمدينة نيويورك بالكامل:

{ &quot;low&quot;: { &quot;latitude&quot;: 40.477398, &quot;longitude&quot;: -74.259087 }, &quot;high&quot;: { &quot;latitude&quot;: 40.91618, &quot;longitude&quot;: -73.70018 } }

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

object (LatLng)

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

object (LatLng)

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