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

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

ملاحظة: هذا الحقل مخصّص لاستخدام حزمة تطوير البرامج (SDK) الخاصة بالسائق فقط. ميزة فك التشفير غير متاحة بعد.

currentRouteSegmentTraffic

object (TrafficPolylineData)

الإدخال فقط يستخدم Fleet Engine هذه المعلومات لتحسين ميزة مشاركة الرحلة. ملاحظة: هذا الحقل مخصّص لاستخدام حزمة تطوير البرامج (SDK) الخاصة بالسائق فقط.

currentRouteSegmentVersion

string (Timestamp format)

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

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

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 في الطلب نفسه.

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

remainingTimeSeconds

integer

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

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

waypoints[]

object (TripWaypoint)

نقاط التوقف المتبقية التي تم تعيينها لهذه المركبة

waypointsVersion

string (Timestamp format)

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

يستخدم معيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا مُعدَّلاً وفقًا لقاعدة Z ويستخدم 0 أو 3 أو 6 أو 9 أرقام عشرية. يتم أيضًا قبول العناصر غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30"

backToBackEnabled

boolean

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

navigationStatus

enum (NavigationStatus)

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

deviceSettings

object (DeviceSettings)

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

VehicleState

حالة Vehicle

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

VehicleAttribute

تصف سمة المركبة كزوج مفتاح/قيمة. لا يمكن أن يتجاوز طول سلسلة "المفتاح:القيمة" 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 يمكن أن تكون قيمة السمة من النوع string أو bool أو double. يمكن أن يكون 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 Undefined LocationPowerSaveMode
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 لن يتم إيقاف الموقع الجغرافي، ولكن سيحدّ LocationManager من جميع الطلبات المرسَلة إلى مقدّمي الخدمات عندما يكون الجهاز غير تفاعلي.

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 مصدر الطاقة هو شاحن التيار المتردد.
POWER_SOURCE_USB مصدر الطاقة هو منفذ USB.
POWER_SOURCE_WIRELESS مصدر الطاقة لاسلكي.
POWER_SOURCE_UNPLUGGED تم فصل البطارية.

الطُرق

create

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

get

تعرِض هذه السمة مركبة من Fleet Engine.

list

تعرِض هذه الوظيفة قائمة مفصّلة بالمركبات المرتبطة بمقدّم خدمة تتطابق مع خيارات الطلب.
تعرِض هذه السمة قائمة بالمركبات التي تتطابق مع خيارات الطلب.

update

يُستخدَم لكتابة بيانات المركبات المعدَّلة في Fleet Engine.

updateAttributes

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