REST Resource: providers.trips

المرجع: رحلة

البيانات الوصفية للرحلة

تمثيل JSON
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
الحقول
name

string

النتائج فقط. بالتنسيق "providers/{provider}/trips/{trip}"

vehicleId

string

رقم تعريف المركبة التي تجري هذه الرحلة

tripStatus

enum (TripStatus)

الحالة الحالية للرحلة

tripType

enum (TripType)

نوع الرحلة.

pickupPoint

object (TerminalLocation)

تشير إلى الموقع الجغرافي الذي يشير فيه العميل إلى أنّه سيتم توصيل الطلب منه.

actualPickupPoint

object (StopLocation)

الإدخال فقط. الموقع الجغرافي الفعلي وقت ومكان استلام العميل. هذا الحقل مخصّص لمقدّم الخدمة لتقديم ملاحظات حول معلومات الاستلام الفعلية.

actualPickupArrivalPoint

object (StopLocation)

الإدخال فقط. الوقت الفعلي والموقع الجغرافي لوصول السائق إلى نقطة الاستلام هذا الحقل مخصّص لمقدّم الخدمة ليقدّم ملاحظات حول معلومات الوصول الفعلية إلى نقطة الاستلام.

pickupTime

string (Timestamp format)

النتائج فقط. سواء الوقت المقدر في المستقبل الذي سيتم فيه نقل الركاب أو الوقت الفعلي الذي تم التقاطهم فيه.

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

intermediateDestinations[]

object (TerminalLocation)

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

intermediateDestinationsVersion

string (Timestamp format)

يشير هذا الحقل إلى آخر مرة تم فيها تعديل intermediateDestinations. يجب أن يخزّن الخادم هذه القيمة مؤقتًا ويمررها في UpdateTripRequest عند تحديث intermediateDestinationIndex لضمان عدم تغيير قيمة intermediateDestinations.

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

intermediateDestinationIndex

integer

عندما تكون قيمة الحقل "TripStatus" ENROUTE_TO_INTERMEDIATE_DESTINATION، رقم بين [0..N-1] يشير إلى الوجهة الوسيطة التي ستعبر المركبة بعد ذلك. عندما تكون قيمة الحقل "TripStatus" ARRIVED_AT_INTERMEDIATE_DESTINATION، رقم بين [0..N-1] يشير إلى الوجهة المتوسطة التي تصل إليها المركبة. يضبط الموفِّر هذه القيمة. في حال عدم توفّر intermediateDestinations، يتم تجاهل هذا الحقل.

actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

الإدخال فقط. الوقت الفعلي والموقع الجغرافي لوصول السائق إلى وجهة متوسطة. هذا الحقل مخصّص لموفّر الخدمة لتقديم ملاحظات عن معلومات الوصول الفعلية إلى الوجهات المتوسطة.

actualIntermediateDestinations[]

object (StopLocation)

الإدخال فقط. الوقت والمكان الفعليان الذي تم فيه نقل العميل من وجهة وسيطة. هذا الحقل مخصّص لموفّر الخدمة لتقديم ملاحظات حول معلومات الاستلام الفعلية في الوجهات المتوسطة.

dropoffPoint

object (TerminalLocation)

الموقع الجغرافي الذي يشير فيه العميل إلى أنّه سيتم تسليمه

actualDropoffPoint

object (StopLocation)

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

dropoffTime

string (Timestamp format)

النتائج فقط. إما الوقت المستقبلي المقدر الذي سيتم فيه تسليم الركاب في الوجهة النهائية، أو الوقت الفعلي الذي تم فيه تسليمهم.

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

remainingWaypoints[]

object (TripWaypoint)

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

vehicleWaypoints[]

object (TripWaypoint)

يتيح هذا الحقل الترتيب اليدوي لنقاط الطريق للرحلة. وتحتوي على جميع نقاط الطريق المتبقية للمركبة المحدّدة، بالإضافة إلى نقاط طريق الركوب والتسليم لهذه الرحلة. إذا لم يتم تخصيص الرحلة لمركبة، يتجاهل Fleet Engine هذا الحقل. لأسباب تتعلق بالخصوصية، لا تتم تعبئة هذا الحقل إلا من خلال الخادم في مكالمات trips.update وtrips.create، وليس في مكالمات trips.get.

route[]

object (LatLng)

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

currentRouteSegment

string

النتائج فقط. مسار مشفر إلى نقطة الطريق التالية.

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

currentRouteSegmentVersion

string (Timestamp format)

النتائج فقط. يشير إلى آخر مرة تم فيها تعديل المسار.

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

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

currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

النتائج فقط. تشير هذه السمة إلى أحوال حركة المرور على طول currentRouteSegment عندما تكون متوفّرة.

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

currentRouteSegmentTrafficVersion

string (Timestamp format)

النتائج فقط. يشير هذا الحقل إلى آخر مرة تم فيها تعديل currentRouteSegmentTraffic.

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

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

currentRouteSegmentEndPoint

object (TripWaypoint)

النتائج فقط. تمثّل هذه السمة النقطة المسارية التي ينتهي عندها currentRouteSegment.

remainingDistanceMeters

integer

النتائج فقط. مسافة القيادة المتبقية في حقل currentRouteSegment. لا يتم تحديد القيمة إذا لم تكن الرحلة مخصّصة لمركبة أو إذا اكتملت الرحلة أو تم إلغاؤها.

etaToFirstWaypoint

string (Timestamp format)

النتائج فقط. الوقت المقدر للوصول إلى نقطة الطريق التالية (الإدخال الأول في الحقل remainingWaypoints). لا يتم تحديد القيمة إذا لم تكن الرحلة مخصّصة لمركبة أو إذا كانت الرحلة غير نشطة (مكتملة أو ملغاة).

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

remainingTimeToFirstWaypoint

string (Duration format)

النتائج فقط. المدة التي تبدأ من وقت إرجاع بيانات الرحلة إلى الوقت في Trip.eta_to_first_waypoint. لا يتم تحديد القيمة إذا لم تكن الرحلة مخصّصة لمركبة أو إذا كانت الرحلة غير نشطة (مكتملة أو ملغاة).

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام "s" مثال: "3.5s"

remainingWaypointsVersion

string (Timestamp format)

النتائج فقط. تشير إلى آخر مرة تم فيها تغيير remainingWaypoints (تمت إضافة نقطة وسيطة أو إزالتها أو تغييرها).

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

remainingWaypointsRouteVersion

string (Timestamp format)

النتائج فقط. يشير إلى آخر مرة تم فيها تعديل remainingWaypoints.path_to_waypoint وremainingWaypoints.traffic_to_waypoint. يجب أن يخزّن تطبيق العميل هذه القيمة مؤقتًا ويمررها في GetTripRequest لضمان عدم عرض المسارات والزيارات إلى remainingWaypoints إلا في حال تعديلها.

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

numberOfPassengers

integer

غير قابل للتغيير. يشير إلى عدد الركاب في هذه الرحلة ولا يشمل السائق. يجب أن تتوفّر في المركبة السعة المتاحة ليتم إرجاعها في استجابة vehicles.search.

lastLocation

object (VehicleLocation)

النتائج فقط. يشير إلى آخر موقع تم الإبلاغ عنه للمركبة على طول المسار.

lastLocationSnappable

boolean

النتائج فقط. يشير هذا الحقل إلى ما إذا كان يمكن محاذاة lastLocation للمركبة في قطاع المسار الحالي. خطأ في حال عدم توفّر lastLocation أو currentRouteSegment. ويتم حسابه باستخدام Fleet Engine. وسيتم تجاهل أي تعديل من العملاء.

view

enum (TripView)

المجموعة الفرعية من حقول "الرحلة" التي تتم تعبئتها وكيفية تفسيرها.

TripStatus

حالة رحلة تشير إلى تقدمها.

عمليات التعداد
UNKNOWN_TRIP_STATUS تلقائي، يُستخدم لحالة الرحلة غير المحدّدة أو غير المعروفة.
NEW رحلة تم إنشاؤها حديثًا
ENROUTE_TO_PICKUP السائق في طريقه إلى نقطة الاستلام.
ARRIVED_AT_PICKUP لقد وصل السائق إلى نقطة الاستلام.
ARRIVED_AT_INTERMEDIATE_DESTINATION وصل السائق إلى وجهة متوسطة وينتظر الراكب.
ENROUTE_TO_INTERMEDIATE_DESTINATION السائق في طريقه إلى وجهة متوسطة (ليست نقطة الانزلاق).
ENROUTE_TO_DROPOFF التقط السائق الراكب وهو في طريقه إلى الوجهة التالية.
COMPLETE تم انسحاب الراكب واكتمال الرحلة.
CANCELED تم إلغاء الرحلة قبل استلام السائق أو الراكب أو مقدّم خدمة مشاركة الرحلات.

StopLocation

الموقع الجغرافي الفعلي الذي وقعت فيه المحطة (الاستلام/التسليم).

تمثيل JSON
{
  "point": {
    object (LatLng)
  },
  "timestamp": string,
  "stopTime": string
}
الحقول
point

object (LatLng)

مطلوب. تشير إلى الموقع الفعلي.

timestamp

string (Timestamp format)

يشير إلى وقت حدوث التوقّف.

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

stopTime
(deprecated)

string (Timestamp format)

الإدخال فقط. تمّ الإيقاف. استخدِم حقل الطابع الزمني.

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

TripView

أداة اختيار مجموعات مختلفة من حقول "الرحلة" في ردّ "trips.get" راجع AIP-157 لمعرفة السياق. من المرجح أن تتم إضافة مشاهدات إضافية.

عمليات التعداد
TRIP_VIEW_UNSPECIFIED القيمة التلقائية. بالنسبة إلى التوافق مع الأنظمة القديمة، سيتم ضبط واجهة برمجة التطبيقات تلقائيًا على طريقة عرض حزمة تطوير البرامج (SDK). لضمان الاستقرار والدعم، ننصح العملاء باختيار TripView بخلاف SDK.
SDK تتضمّن الحقول التي قد لا تكون قابلة للتفسير أو الدعم باستخدام المكتبات المتاحة للجميع.
JOURNEY_SHARING_V1S تتم تعبئة حقول الرحلة لحالة استخدام "مشاركة الرحلة". تم تصميم طريقة العرض هذه لاتصالات خادم إلى خادم.

الطُرق

create

ينشئ رحلة في Fleet Engine ويعرض الرحلة الجديدة.

get

الحصول على معلومات عن رحلة واحدة
يمكنك الاطّلاع على جميع الرحلات لمركبة معيّنة.

update

تعدّل بيانات الرحلة.