REST Resource: providers.vehicles

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

string

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

enum (VehicleState)

حالة المركبة

enum (TripType)

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

string

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

object (VehicleLocation)

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

integer

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

object (VehicleAttribute)

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

object (VehicleType)

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

object (LicensePlate)

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

object (TerminalLocation)

مهملة: يمكنك استخدام Vehicle.waypoints بدلاً منها.

string

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

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

object (TrafficPolylineData)

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

string (Timestamp format)

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

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

object (TripWaypoint)

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

integer

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

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"

integer

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

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

object (TripWaypoint)

نقاط الطريق المتبقية المخصّصة لهذه المركبة

string (Timestamp format)

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

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

boolean

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

enum (NavigationStatus)

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

object (DeviceSettings)

الإدخال فقط. معلومات حول الإعدادات في الجهاز الجوّال التي يستخدمها برنامج التشغيل.

{
  "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.
}

string

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

string

تمثّل هذه السمة قيمة السمة.

string

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

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

boolean

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

number

قيمة سمة مكتوبة بنمط مزدوج.

{
  "category": enum (Category)
}

enum (Category)

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

{
  "countryCode": string,
  "lastCharacter": string
}

string

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

string

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

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

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}

object (RoadStretch)

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

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

{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}

enum (Style)

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

integer

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

integer

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

{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}

enum (LocationPowerSaveMode)

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

boolean

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

boolean

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

object (BatteryInfo)

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

{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}

enum (BatteryStatus)

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

enum (PowerSource)

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

number

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