الفهرس
NavConnectService(واجهة)AuthToken(رسالة)CreateTripRequest(رسالة)GetTripRequest(رسالة)Location(رسالة)Stop(رسالة)Trip(رسالة)Trip.State(تعداد)TripConfig(رسالة)TripExecution(رسالة)
NavConnectService
خدمة تتيح لعملاء NavConnect إنشاء الرحلات والحصول عليها.
| CreateTrip |
|---|
|
تنشئ هذه الطريقة رحلة. يجب طلب هذا الإذن قبل أن يتمكّن تطبيق الأجهزة الجوّالة من بدء الرحلة. ستتضمّن الرحلة التي تم إرجاعها الحقل
|
| GetTrip |
|---|
|
تعرض هذه الطريقة رحلة.
|
AuthToken
رمز مميز للمصادقة
| الحقول | |
|---|---|
token |
النتائج فقط. رمز المصادقة الذي يجب تمريره إلى تطبيق الأجهزة الجوّالة |
expire_time |
النتائج فقط. الوقت الذي ستنتهي فيه صلاحية رمز المصادقة المميز |
CreateTripRequest
رسالة الطلب الخاصة بـ NavConnectService.CreateTrip
| الحقول | |
|---|---|
parent |
الحقل مطلوب. تمثّل هذه السمة المورد الأصلي الذي سيتم إنشاء هذه الرحلة ضمنه. التنسيق: projects/{project_number} |
trip_id |
الحقل مطلوب. رقم التعريف الذي سيتم استخدامه للرحلة، والذي سيصبح المكوّن النهائي لاسم مورد الرحلة. يجب أن تكون هذه القيمة معرّفًا فريدًا عالميًا (UUID) صالحًا من RFC-4122. |
trip |
الحقل مطلوب. الرحلة المطلوب إنشاؤها |
GetTripRequest
طلب رسالة NavConnectService.GetTrip
| الحقول | |
|---|---|
name |
الحقل مطلوب. اسم المورد للرحلة المطلوب الحصول عليها. التنسيق: projects/{project}/trips/{trip_id} |
الموقع الجغرافي
موقع جغرافي كما تم الإبلاغ عنه من خلال تطبيق الأجهزة الجوّالة
| الحقول | |
|---|---|
point |
النتائج فقط. خطوط الطول والعرض للموقع الجغرافي |
source_time |
النتائج فقط. الوقت الذي تم فيه الحصول على الموقع الجغرافي كما هو موضّح من قِبل العميل |
server_time |
النتائج فقط. الوقت الذي تلقّى فيه الخادم إشعارًا بشأن الموقع الجغرافي هذا. |
إيقاف
هي محطة في الرحلة حيث يجب تنفيذ بعض المهام.
| الحقول | |
|---|---|
point |
الحقل مطلوب. موقع المحطة الجغرافية كخط طول/عرض |
الرحلة
رحلة
| الحقول | |
|---|---|
name |
النتائج فقط. المعرّف. تمثّل هذه السمة اسم المورد الخاص بالرحلة. التنسيق: projects/{project_number}/trips/{trip_id}. |
config |
غير قابل للتغيير تمثّل هذه السمة إعدادات الرحلة. |
android_app_id |
الإدخال فقط غير قابل للتغيير معرّف تطبيق Android للتطبيق المتوافق مع الأجهزة الجوّالة الذي سيتم استخدام الرحلة فيه. يجب ضبط قيمة واحدة على الأقل من |
ios_app_id |
الإدخال فقط غير قابل للتغيير معرّف حزمة iOS للتطبيق المتوافق مع الأجهزة الجوّالة الذي سيتم استخدام الرحلة فيه يجب ضبط قيمة واحدة على الأقل من |
auth_token |
النتائج فقط. رمز مميّز غير شفاف يمنح الإذن ببدء رحلة NavConnect في "خرائط Google" أو Waze ويمنح هذه التطبيقات إذن تعديل الرحلة. يتم عرضها فقط من خلال |
state |
النتائج فقط. حالة الرحلة |
execution |
النتائج فقط. أحدث البيانات حول تنفيذ الرحلة قد لا يتم ضبط هذه السمة إذا كانت الرحلة في حالة خطأ. |
create_time |
النتائج فقط. الوقت وفقًا للخادم عند إنشاء الرحلة |
update_time |
النتائج فقط. الوقت الذي تلقّى فيه الخادم آخر تحديث للرحلة |
ولاية
جميع حالات الرحلة المحتملة
| عمليات التعداد | |
|---|---|
STATE_UNSPECIFIED |
حالة الرحلة غير محدّدة. |
NEW |
تم إنشاء الرحلة ولكن لم تبدأ بعد. |
ENROUTE |
يكون الناقل في طريقه إلى الوجهة. |
ARRIVED |
وصلت وسيلة النقل إلى الوجهة. |
SUSPENDED |
تم تعليق الرحلة. |
FAILED |
تعذّر إكمال الرحلة بنجاح. |
CLIENT_ERROR |
تعذّر إكمال الرحلة بسبب خطأ في البرنامج. |
TripConfig
إعدادات الرحلة
| الحقول | |
|---|---|
enable_high_frequency_updates |
اختياريّ. تحدّد هذه السمة ما إذا كان سيتم تفعيل تحديثات الرحلات العالية التكرار. ملاحظة: يؤدي تفعيل هذه الميزة إلى تسجيل الرحلة ضمن استخدام "الفئة المخصّصة للمؤسسات"، وتخضع لرسوم هذه الفئة. |
enable_pubsub |
اختياريّ. تُستخدَم لتحديد ما إذا كان سيتم تفعيل إشعارات pubsub للرحلة. |
pubsub_field_mask |
اختياريّ. في حال ضبط هذا الخيار، سيتم تضمين المجموعة الفرعية المحدّدة فقط من حقول الرحلة في إشعارات pubsub. في حال عدم ضبط هذا الحقل، سيتم تضمين جميع حقول الرحلة في إشعارات pubsub (السلوك التلقائي). الحقول التالية غير متاحة:
ملاحظة: يتم تجاهل هذا الحقل إذا كانت قيمة |
TripExecution
بيانات حول تنفيذ الرحلة
| الحقول | |
|---|---|
origin |
النتائج فقط. مصدر الرحلة، وهو بشكل عام الموقع الجغرافي لشركة النقل عند بدء رحلة NavConnect. |
destination |
النتائج فقط. وجهة الرحلة كما تمّ الإبلاغ عنها من خلال تطبيق الأجهزة الجوّالة. |
location |
النتائج فقط. إشارة الموقع الجغرافي التي تمثّل آخر موقع جغرافي معروف لشركة النقل سيكون هذا هو الموقع الجغرافي الذي تم تعديله ليتطابق مع الطريق، إذا كان متاحًا. |
traveled_duration |
النتائج فقط. الوقت الذي استغرقته الرحلة حتى الآن |
remaining_duration |
النتائج فقط. الوقت المتبقي في هذه الرحلة كما تقدّره Google |
traveled_distance_meters |
النتائج فقط. المسافة المقطوعة من نقطة الانطلاق بالمتر |
remaining_distance_meters |
النتائج فقط. المسافة المتبقية إلى الوجهة بالمتر |
stop_added_in_route |
النتائج فقط. تشير هذه السمة إلى ما إذا تمت إضافة محطة توقّف على طول المسار. |