REST Resource: providers.vehicles

المرجع: مركبة

البيانات الوصفية للمركبة

تمثيل JSON
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
الحقول
name

string

النتائج فقط. الاسم الفريد لهذه المركبة التنسيق هو providers/{provider}/vehicles/{vehicle}.

vehicleState

enum (VehicleState)

حالة المركبة

supportedTripTypes[]

enum (TripType)

أنواع الرحلات المتوافقة مع هذه المركبة

currentTrips[]

string

النتائج فقط. قائمة برحلات "tripId" للرحلات المخصّصة حاليًا لهذه المركبة

lastLocation

object (VehicleLocation)

آخر موقع جغرافي تم الإبلاغ عنه للمركبة

maximumCapacity

integer

تمثّل هذه السمة إجمالي عدد الركاب الذين يمكن أن تحملهم هذه المركبة. ولا يتمّ اعتبار عامل التشغيل ضمن هذه القيمة. يجب أن تكون هذه القيمة أكبر من واحد أو مساوية له.

attributes[]

object (VehicleAttribute)

تمثّل هذه السمة قائمة سمات المركبات. يمكن أن تتضمّن المركبة 100 سمة كحدّ أقصى، ويجب أن تحتوي كل سمة على مفتاح فريد.

vehicleType

object (VehicleType)

مطلوب. تعرض هذه السمة نوع هذه المركبة. يمكن استخدامها لفلترة المركبات في vehicles.search نتائج. يؤثر أيضًا على الوقت المقدر للوصول وحساب المسار.

licensePlate

object (LicensePlate)

معلومات لوحة ترخيص المركبة

route[]
(deprecated)

object (TerminalLocation)

متوقّفة نهائيًا: استخدِم Vehicle.waypoints بدلاً منها.

currentRouteSegment

string

الخطوط المتعددة التي تحدد المسار الذي ينوي تطبيق السائق اتباعه إلى نقطة الطريق التالية. ويتم أيضًا عرض هذه القائمة بعملة Trip.current_route_segment لكل الرحلات النشطة المخصّصة للمركبة.

ملاحظة: هذا الحقل مخصَّص فقط لاستخدام Driver SDK. لا تتوفّر إمكانية فك الترميز بعد.

currentRouteSegmentTraffic

object (TrafficPolylineData)

الإدخال فقط. يستخدم Fleet Engine هذه المعلومات لتحسين مشاركة الرحلة. ملاحظة: هذا الحقل مخصَّص فقط لاستخدام Driver SDK.

currentRouteSegmentVersion

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه ضبط السمة currentRouteSegment ويمكن أن يخزّنه العميل وتمريره في طلبات vehicles.get المستقبلية لمنع مسارات العودة التي لم تتغيّر.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

currentRouteSegmentEndPoint

object (TripWaypoint)

تمثّل هذه السمة النقطة المسارية التي ينتهي عندها currentRouteSegment. يمكن توفير ذلك من قِبل السائقين في مكالمات vehicles.update إما كنقطة طريق كاملة للرحلة أو نقطة وسيطة LatLng أو آخر LatLng من currentRouteSegment. وسيبذل Fleet Engine قصارى جهده للدمج في نقطة طريق فعلية إذا لم يتم تحديدها بشكل كامل. يتم تجاهل هذا الحقل في استدعاءات vehicles.update ما لم يتم تحديد currentRouteSegment أيضًا.

remainingDistanceMeters

integer

مسافة القيادة المتبقية لـ currentRouteSegment. يتم أيضًا عرض هذه القيمة بعملة Trip.remaining_distance_meters لكل الرحلات النشطة المخصّصة للمركبة. لا يتم تحديد القيمة إذا كان الحقل currentRouteSegment فارغًا.

etaToFirstWaypoint

string (Timestamp format)

الوقت المقدّر للوصول إلى الإدخال الأول في الحقل waypoints. لا يتم تحديد القيمة إذا كان الحقل waypoints فارغًا أو الحقل Vehicle.current_route_segment فارغًا.

عند تعديل مركبة، تكون الأولوية للسمة remainingTimeSeconds على etaToFirstWaypoint في الطلب نفسه.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

remainingTimeSeconds

integer

الإدخال فقط. الوقت المتبقّي لقيادة السيارة "currentRouteSegment" لا يتم تحديد القيمة إذا كان الحقل waypoints فارغًا أو الحقل Vehicle.current_route_segment فارغًا. يجب أن تتطابق هذه القيمة مع etaToFirstWaypoint - current_time إذا كانت جميع الجهات تستخدم الساعة نفسها.

عند تعديل مركبة، تكون الأولوية للسمة remainingTimeSeconds على etaToFirstWaypoint في الطلب نفسه.

waypoints[]

object (TripWaypoint)

تمثّل هذه السمة نقاط الطريق المتبقية لهذه المركبة.

waypointsVersion

string (Timestamp format)

النتائج فقط. آخر مرة تم فيها تعديل الحقل waypoints. على العملاء تخزين هذه القيمة مؤقتًا وتمريرها في GetVehicleRequest لضمان عرض الحقل waypoints في حال تعديله فقط.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

backToBackEnabled

boolean

يشير هذا الحقل إلى ما إذا كان السائق يقبل الرحلات المتتالية. إذا كانت true، قد تشمل vehicles.search المركبة حتى إذا كانت مخصصة حاليًا لرحلة. القيمة التلقائية هي false.

navigationStatus

enum (NavigationStatus)

حالة التنقّل في المركبة

deviceSettings

object (DeviceSettings)

الإدخال فقط. معلومات حول الإعدادات في الجهاز الجوّال الذي يستخدمه السائق.

VehicleState

حالة Vehicle.

عمليات التعداد
UNKNOWN_VEHICLE_STATE الخيار التلقائي، يُستخدم في حالات المركبات غير المحدّدة أو غير المعروفة.
OFFLINE لا تقبل المركبة رحلات جديدة. ملاحظة: قد تستمر المركبة في العمل في هذه الحالة أثناء إكمال رحلة مخصصة لها.
ONLINE تقبل المركبة رحلات جديدة.

VehicleAttribute

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

تمثيل JSON
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
الحقول
key

string

مفتاح السمة. لا يجوز أن تحتوي المفاتيح على علامة النقطتين (:).

value

string

قيمة السمة.

حقل الاتحاد vehicle_attribute_value. قيمة السمة، يمكن أن تكون في سلسلة أو قيمة منطقية أو نوع مزدوج. يمكن أن يكون vehicle_attribute_value واحدًا فقط مما يلي:
stringValue

string

قيمة السمة المكتوبة بالسلسلة

ملاحظة: هذا مماثل للحقل value الذي سيتم إيقافه نهائيًا في النهاية. بالنسبة إلى طرق الإنشاء أو التعديل، يمكن استخدام أي من الحقلَين، ولكن يُنصح بشدة باستخدام stringValue. إذا تم ضبط كل من stringValue وvalue، يجب أن تكون القيمتان متطابقتَين وإلا سيتم حدوث خطأ. تتم تعبئة كلا الحقلين في الردود.

boolValue

boolean

قيمة السمة المكتوبة بطريقة منطقية

numberValue

number

قيمة سمة من نوعين

VehicleType

تمثّل هذه السمة نوع المركبة.

تمثيل JSON
{
  "category": enum (Category)
}
الحقول
category

enum (Category)

فئة نوع المركبة

الفئة

فئات أنواع المركبات

عمليات التعداد
UNKNOWN الخيار التلقائي، يُستخدَم لفئات المركبات غير المحدَّدة أو غير المعروفة.
AUTO سيارة.
TAXI تمثّل هذه السمة أي مركبة تُستخدم كسيارة أجرة (عادةً ما تكون مرخّصة أو خاضعة للرقابة).
TRUCK بشكل عام، تكون المركبات ذات سعة تخزين كبيرة.
TWO_WHEELER دراجة نارية أو دراجة نارية أو مركبة أخرى ذات عجلتين
BICYCLE نقل يعمل بآلية بشرية
PEDESTRIAN ناقل إنسان يسير على الأقدام أو يركض في العادة على طول ممرات المشاة

LicensePlate

تعرض هذه السمة معلومات لوحة ترخيص المركبة. ولتجنّب تخزين معلومات تحديد الهوية الشخصية، يتم تخزين الحد الأدنى من المعلومات المتوفّرة عن لوحة تسجيل المركبة فقط كجزء من الكيان.

تمثيل JSON
{
  "countryCode": string,
  "lastCharacter": string
}
الحقول
countryCode

string

مطلوب. رمز البلد/المنطقة في CLDR على سبيل المثال، US للولايات المتحدة أو IN للهند.

lastCharacter

string

الرقم الأخير من لوحة ترخيص المركبة أو "-1" للإشارة إلى عدم توفّر قيمة رقمية في لوحة تسجيل المركبة

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • "ABCDEF" -> "1-"

TrafficPolylineData

أحوال حركة المرور على طول مسار المركبة المتوقّع

تمثيل JSON
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
الحقول
trafficRendering

object (VisualTrafficReportPolylineRendering)

عرض متعدّد الخطوط يوضّح مدى سرعة حركة المرور في جميع المناطق على طول جزء واحد من رحلة العميل

VisualTrafficReportPolylineRendering

يصف كيف يجب على العملاء تلوين جزء واحد من الخطوط المتعددة على طول المسار.

تمثيل JSON
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
الحقول
roadStretch[]

object (RoadStretch)

اختياريّ. امتدادات الطرق التي يجب عرضها على طول الخطوط المتعددة. يضمن عدم تداخل الامتدادات، ولا يعني بالضرورة امتداد المسار بالكامل.

في حالة عدم وجود امتداد الطريق إلى النمط، يجب على العميل تطبيق الإعداد الافتراضي للمسار.

RoadStretch

امتداد واحد للطريق يجب عرضه.

تمثيل JSON
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
الحقول
style

enum (Style)

مطلوب. النمط المراد تطبيقه.

offsetMeters

integer

مطلوب. يجب تطبيق النمط بين [offsetMeters, offsetMeters + lengthMeters).

lengthMeters

integer

مطلوب. طول المسار حيث يتم تطبيق النمط.

النمط

نمط حركة المرور، الذي يشير إلى سرعة حركة المرور.

عمليات التعداد
STYLE_UNSPECIFIED لم يتم اختيار أي نمط.
SLOWER_TRAFFIC حركة المرور بطيئة
TRAFFIC_JAM هناك ازدحام مروري.

DeviceSettings

معلومات حول الإعدادات المختلفة على الجهاز الجوّال.

تمثيل JSON
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
الحقول
locationPowerSaveMode

enum (LocationPowerSaveMode)

كيفية ضبط ميزات الموقع الجغرافي على الجهاز عند تفعيل ميزة "توفير شحن البطارية"

isPowerSaveMode

boolean

ما إذا كان الجهاز في وضع توفير الطاقة حاليًا.

isInteractive

boolean

ما إذا كان الجهاز في حالة تفاعلية.

batteryInfo

object (BatteryInfo)

معلومات حول حالة البطارية

LocationPowerSaveMode

كيفية ضبط ميزات الموقع الجغرافي لتعمل على الجهاز الجوّال عند تفعيل ميزة "توفير شحن البطارية" في الأجهزة الميزة مفعّلة. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

عمليات التعداد
UNKNOWN_LOCATION_POWER_SAVE_MODE موضع حفظ PowerSaveMode (موقع جغرافي) غير محدّد
LOCATION_MODE_NO_CHANGE يجب ألا يتأثر موفرو المواقع الجغرافية بميزة "توفير شحن البطارية" أو أن هذه الميزة غير مفعّلة.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF يجب إيقاف موفّر الموقع الجغرافي المستند إلى نظام تحديد المواقع العالمي (GPS) عند تفعيل ميزة "توفير شحن البطارية" وعندما يكون الجهاز غير تفاعلي.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF يجب إيقاف جميع موفري المواقع الجغرافية عندما تكون ميزة "توفير شحن البطارية" مفعَّلة ويكون الجهاز غير تفاعلي.
LOCATION_MODE_FOREGROUND_ONLY ستتم إتاحة جميع موفري المواقع الجغرافية، ولكن يجب تقديم إصلاحات الموقع الجغرافي فقط للتطبيقات التي تعمل في المقدّمة.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF لن يتم إيقاف خدمة الموقع الجغرافي، ولكن سيقلل "مدير الموقع الجغرافي" جميع الطلبات المُرسَلة إلى مقدّمي الخدمات عندما يكون الجهاز غير تفاعلي.

BatteryInfo

معلومات حول بطارية الجهاز

تمثيل JSON
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
الحقول
batteryStatus

enum (BatteryStatus)

حالة البطارية، سواء كانت ممتلئة أو مشحونة وغير ذلك

powerSource

enum (PowerSource)

حالة مصدر طاقة البطارية

batteryPercentage

number

نسبة شحن البطارية الحالية [0-100].

BatteryStatus

حالة البطارية، سواء كانت ممتلئة أو مشحونة وغير ذلك

عمليات التعداد
UNKNOWN_BATTERY_STATUS حالة البطارية غير معروفة.
BATTERY_STATUS_CHARGING يتم شحن البطارية.
BATTERY_STATUS_DISCHARGING يتم تفريغ شحن البطارية.
BATTERY_STATUS_FULL البطارية ممتلئة.
BATTERY_STATUS_NOT_CHARGING البطارية لا تشحن.
BATTERY_STATUS_POWER_LOW طاقة البطارية منخفضة.

PowerSource

نوع الشاحن المستخدَم لشحن البطارية

عمليات التعداد
UNKNOWN_POWER_SOURCE مصدر الطاقة غير معروف.
POWER_SOURCE_AC مصدر الطاقة هو شاحن AC.
POWER_SOURCE_USB مصدر الطاقة هو منفذ USB.
POWER_SOURCE_WIRELESS مصدر الطاقة لاسلكي.
POWER_SOURCE_UNPLUGGED البطارية غير متصلة.

الطُرق

create

ينشئ مثيلاً لمركبة جديدة مرتبطة بمقدّم خدمة مشاركة الرحلات أو خدمات التسليم عند الطلب.

get

لعرض مركبة من Fleet Engine.

list

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

update

كتابة بيانات المركبة المعدّلة في Fleet Engine

updateAttributes

يتم تعديل سمات المركبة جزئيًا.