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
}
الحقول
enableHighFrequencyUpdates

boolean

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

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

boolean

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

string (FieldMask format)

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

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

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

  • androidAppId
  • iosAppId
  • authToken
  • config

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

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

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 تعذّر إكمال الرحلة بسبب خطأ في البرنامج.

TripExecution

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

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

object (Location)

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

object (Stop)

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

object (Location)

النتائج فقط. إشارة الموقع الجغرافي التي تمثّل آخر موقع جغرافي معروف لشركة النقل سيكون هذا هو الموقع الجغرافي الذي تم تعديله ليتطابق مع الطريق، إذا كان متاحًا.
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)

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

الطُرق

create

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

get

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