REST Resource: projects.trips

نوع المرجع: رحلة

رحلة

تمثيل JSON
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
الحقول
name

string

النتائج فقط. المعرّف. تمثّل هذه السمة اسم المورد الخاص بالرحلة. التنسيق: projects/{project_number}/trips/{tripId}.

config

object (TripConfig)

هذا الحقل غير قابل للتغيير ويمثّل إعدادات الرحلة.

androidAppId

string

الإدخال فقط غير قابل للتغيير معرّف تطبيق Android للتطبيق المتوافق مع الأجهزة الجوّالة الذي سيتم استخدام الرحلة فيه. يجب ضبط قيمة واحدة على الأقل من androidAppId أو iosAppId.

iosAppId

string

الإدخال فقط غير قابل للتغيير معرّف حزمة iOS للتطبيق المتوافق مع الأجهزة الجوّالة الذي سيتم استخدام الرحلة فيه يجب ضبط قيمة واحدة على الأقل من androidAppId أو iosAppId.

authToken

object (AuthToken)

النتائج فقط. رمز مميّز غير شفاف يمنح الإذن ببدء رحلة NavConnect في "خرائط Google" أو Waze ويمنح هذه التطبيقات إذن تعديل الرحلة. يتم عرضها فقط من خلال trips.create.

state

enum (State)

النتائج فقط. حالة الرحلة

execution

object (TripExecution)

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

createTime

string (Timestamp format)

نتائج فقط. الوقت وفقًا للخادم عند إنشاء الرحلة.

يستخدم المعيار 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".

updateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تلقّى فيه الخادم آخر تحديث للرحلة

يستخدم المعيار 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".

TripConfig

إعدادات الرحلة

تمثيل JSON
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string,
  "enableRemainingRouteReporting": boolean
}
الحقول
enableHighFrequencyUpdates

boolean

اختياريّ. تحديد ما إذا كان سيتم تفعيل تحديثات الرحلات العالية التكرار.

ملاحظة: يؤدي تفعيل هذه الميزة إلى تسجيل الرحلة ضمن استخدام "فئة المؤسسات"، وتخضع لرسوم "فئة المؤسسات".

enablePubsub

boolean

اختياريّ. تحديد ما إذا كان سيتم تفعيل إشعارات pubsub للرحلة

pubsubFieldMask

string (FieldMask format)

اختياريّ. في حال ضبط هذا الحقل، سيتم تضمين المجموعة الفرعية المحدّدة فقط من حقول الرحلة في إشعارات pubsub.

في حال عدم ضبط هذا الحقل، سيتم تضمين جميع حقول الرحلة في إشعارات Pub/Sub (السلوك التلقائي).

الحقول التالية غير متاحة:

  • androidAppId
  • iosAppId
  • authToken
  • config

ملاحظة: يتم تجاهل هذا الحقل إذا كانت قيمة enablePubsub هي "false".

هذه قائمة قيم مفصولة بفاصلة تتضمّن الأسماء المؤهَّلة بالكامل للحقول. مثال: "user.displayName,photo"

enableRemainingRouteReporting

boolean

اختياريّ. تحديد ما إذا كان سيتم تفعيل ميزة الإبلاغ عن المسار المتبقي للرحلة.

ملاحظة: يؤدي تفعيل هذه الميزة إلى تسجيل الرحلة ضمن استخدام "فئة المؤسسات"، وتخضع لرسوم "فئة المؤسسات".

AuthToken

رمز مميز للمصادقة

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

string

النتائج فقط. رمز المصادقة الذي يجب تمريره إلى تطبيق الأجهزة الجوّالة

expireTime

string (Timestamp format)

للقراءة فقط. الوقت الذي ستنتهي فيه صلاحية رمز المصادقة المميز.

يستخدم المعيار 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".

ولاية

جميع حالات الرحلة المحتملة

عمليات التعداد
STATE_UNSPECIFIED لم يتم تحديد حالة الرحلة.
NEW تم إنشاء الرحلة ولكن لم تبدأ بعد.
ENROUTE يكون الناقل في طريقه إلى الوجهة.
ARRIVED وصلت وسيلة النقل إلى الوجهة.
SUSPENDED تم تعليق الرحلة.
FAILED تعذّر إكمال الرحلة بنجاح.
CLIENT_ERROR تعذّر إكمال الرحلة بسبب خطأ في البرنامج.
CANCELED تم إلغاء الرحلة صراحةً من قِبل المطوّر.

TripExecution

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

تمثيل JSON
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "remainingRoute": {
    object (Route)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
الحقول
origin

object (Location)

النتائج فقط. مصدر الرحلة وهو بشكل عام الموقع الجغرافي لشركة النقل عند بدء رحلة NavConnect.

destination

object (Stop)

النتائج فقط. وجهة الرحلة كما تمّ تسجيلها من خلال تطبيق الأجهزة الجوّالة.

location

object (Location)

للعرض فقط: إشارة الموقع الجغرافي التي تمثّل آخر موقع جغرافي معروف لوسيلة النقل. سيكون هذا الموقع الجغرافي هو الموقع الجغرافي الذي تم ضبطه على الطريق إذا كان متاحًا.

remainingRoute

object (Route)

النتائج فقط: تقدّم هذه السمة الخط المتعدد الأضلاع للجزء المتبقي من المسار.

traveledDuration

string (Duration format)

النتائج فقط. الوقت الذي استغرقته الرحلة حتى الآن

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

remainingDuration

string (Duration format)

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

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

traveledDistanceMeters

integer

النتائج فقط. المسافة المقطوعة من نقطة الانطلاق بالمتر

remainingDistanceMeters

integer

نتائج فقط. المسافة المتبقية للوصول إلى الوجهة بالمتر.

stopAddedInRoute

boolean

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

الموقع الجغرافي

موقع جغرافي كما تم الإبلاغ عنه من خلال تطبيق الأجهزة الجوّالة

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

object (LatLng)

النتائج فقط. خطوط الطول والعرض للموقع الجغرافي

sourceTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه الحصول على الموقع الجغرافي كما هو موضّح من قِبل العميل

يستخدم المعيار 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".

serverTime

string (Timestamp format)

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

يستخدم المعيار 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".

LatLng

كائن يمثّل زوج خط العرض/خط الطول. يتم التعبير عن ذلك كزوج من الأرقام المضاعفة لتمثيل درجات خط العرض ودرجات خط الطول. ما لم يُذكر خلاف ذلك، يجب أن يتوافق هذا العنصر مع معيار WGS84. يجب أن تكون القيم ضمن النطاقات العادية.

تمثيل JSON
{
  "latitude": number,
  "longitude": number
}
الحقول
latitude

number

خط العرض بالدرجات، ويجب أن يكون في النطاق [-90.0, +90.0].

longitude

number

خط الطول بالدرجات، ويجب أن يكون في النطاق [-180.0, +180.0].

إيقاف

محطة في الرحلة حيث يجب تنفيذ بعض المهام

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

object (LatLng)

الحقل مطلوب. موقع المحطة الجغرافية كخط طول/عرض

مسار

خطوط متعددة لمسار

تمثيل JSON
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
الحقول
trafficInformation[]

object (SpeedReadingInterval)

النتائج فقط. معلومات حركة المرور على الخط المتعدد الأضلاع الموصوف كفواصل قراءة السرعة

NOTES:

  • الفواصل الزمنية غير متداخلة.
  • يجب أن تكون الفواصل الزمنية متجاورة.
  • تغطي الفواصل الخط المتعدد بأكمله.
  • يتم ترتيب الفواصل الزمنية حسب المؤشر المتزايد.
  • يتم تحديد السرعة لكل فاصل زمني.

حقل الربط format تنسيق المسار

يتم التحكّم في التنسيق الذي تتم تعبئته من خلال المَعلمة route_polyline_format. إذا لم يتم ضبطها، سيتم تلقائيًا استخدام خط متعدد بسيط. يمكن أن يكون التعليق format إحدى القيم التالية فقط:

simplePolyline

object (SimplePolyline)

النتائج فقط. المسار كقائمة بسيطة من قيم خطوط الطول والعرض

encodedPolyline

string

هذا الحقل مخصّص للإخراج فقط. يمثّل المسار كسلسلة خطوط متعدّدة مرمّزة. يمكنك الاطّلاع على https://developers.google.com/maps/documentation/utilities/polylinealgorithm.

s2Polyline

string (bytes format)

النتائج فقط: المسار كـ S2Polyline مشفّر. يمكنك الاطّلاع على https://s2geometry.io/devguide/basic_types.html.

سلسلة مرمّزة باستخدام Base64

geoJson

object (Struct format)

هذا الحقل مخصّص للناتج فقط. يمثّل المسار بتنسيق GeoJSON LineString. يمكنك الاطّلاع على https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

تمثّل هذه السمة خطًا متعدد الأضلاع باستخدام قائمة بسيطة من النقاط.

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

object (LatLng)

النتائج فقط. قائمة مرتَّبة من النقاط التي تمثّل الخط المتعدد

SpeedReadingInterval

مؤشر كثافة حركة المرور على جزء متجاور من مسار بالنظر إلى مسار يتضمّن النقاط P_0 وP_1 و... وP_N (فهرس يبدأ من الصفر)، يحدّد SpeedReadingInterval فاصلًا زمنيًا ويصف حركة المرور فيه باستخدام فئات Speed.

تمثيل JSON
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
الحقول
speed

enum (Speed)

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

startPolylinePointIndex

integer

النتائج فقط. الفهرس الأوّلي لهذا الفاصل الزمني في المسار

endPolylinePointIndex

integer

النتائج فقط. تمثّل هذه السمة فهرس نهاية الفاصل الزمني في المسار.

السرعة

تصنيف سرعة الخطوط المتعددة استنادًا إلى بيانات حركة المرور

عمليات التعداد
SPEED_UNSPECIFIED لم يتم تحديد السرعة.
NORMAL السرعة العادية، لا يوجد تأخير في حركة المرور
SLOW تم رصد تباطؤ في حركة المرور، مستوى حركة المرور من خفيف إلى متوسط.
TRAFFIC_JAM حالات التأخير في حركة المرور، بما في ذلك الازدحام المروري الخانق

الطُرق

create

تنشئ هذه الطريقة رحلة.

get

تعرض هذه الطريقة رحلة.