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 لجميع الرحلات النشطة التي تم إسنادها إلى المركبة.

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

object (TrafficPolylineData)

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

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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 "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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 "Zulu" ، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

 تعرض قائمة بالمركبات مقسّمة على صفحات والمرتبطة بمقدّم خدمة يتطابق مع خيارات الطلب.
تعرض قائمة بالمركبات التي تتطابق مع خيارات الطلب.

searchFuzzed
(deprecated)

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

update

 تكتب بيانات المركبة في Fleet Engine.

updateAttributes

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

updateLocation
(deprecated)

 متوقّفة نهائيًا: يمكنك استخدام طريقة UpdateVehicle بدلاً من ذلك.