Package google.maps.navconnect.v1

الفهرس

خدمة تتيح لعملاء NavConnect إنشاء الرحلات والحصول عليها.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

تنشئ هذه الطريقة رحلة. يجب طلب هذا الإذن قبل أن يتمكّن تطبيق الأجهزة الجوّالة من بدء الرحلة. ستتضمّن الرحلة التي تم إرجاعها الحقل auth_token.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

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

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/cloud-platform

AuthToken

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

الحقول
token

string

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

expire_time

Timestamp

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

CreateTripRequest

رسالة الطلب الخاصة بـ NavConnectService.CreateTrip

الحقول
parent

string

الحقل مطلوب. تمثّل هذه السمة المورد الأصلي الذي سيتم إنشاء هذه الرحلة ضمنه. التنسيق: projects/{project_number}

trip_id

string

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

يجب أن تكون هذه القيمة معرّفًا فريدًا عالميًا (UUID) صالحًا من RFC-4122.

trip

Trip

الحقل مطلوب. الرحلة المطلوب إنشاؤها

GetTripRequest

طلب رسالة NavConnectService.GetTrip

الحقول
name

string

الحقل مطلوب. اسم المورد للرحلة المطلوب الحصول عليها. التنسيق: projects/{project}/trips/{trip_id}

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

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

الحقول
point

LatLng

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

source_time

Timestamp

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

server_time

Timestamp

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

إيقاف

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

الحقول
point

LatLng

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

الرحلة

رحلة

الحقول
name

string

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

config

TripConfig

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

android_app_id

string

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

ios_app_id

string

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

auth_token

AuthToken

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

state

State

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

execution

TripExecution

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

create_time

Timestamp

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

update_time

Timestamp

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

ولاية

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

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

TripConfig

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

الحقول
enable_high_frequency_updates

bool

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

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

enable_pubsub

bool

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

pubsub_field_mask

FieldMask

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

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

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

  • android_app_id
  • ios_app_id
  • auth_token
  • config

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

TripExecution

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

الحقول
origin

Location

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

destination

Stop

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

location

Location

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

traveled_duration

Duration

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

remaining_duration

Duration

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

traveled_distance_meters

int32

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

remaining_distance_meters

int32

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

stop_added_in_route

bool

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