Package google.maps.navconnect.v1

الفهرس

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

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

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

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

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

  • https://www.googleapis.com/auth/cloud-platform
أذونات "إدارة الهوية وإمكانية الوصول"

يتطلّب الإذن التالي في إدارة الهوية وإمكانية الوصول (IAM) على مورد parent:

  • navigationconnect.trips.create

لمزيد من المعلومات، يُرجى الاطّلاع على مستندات "إدارة الهوية وإمكانية الوصول".
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

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

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

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

  • https://www.googleapis.com/auth/cloud-platform
أذونات "إدارة الهوية وإمكانية الوصول"

يتطلّب الإذن التالي في إدارة الهوية وإمكانية الوصول (IAM) على مورد name:

  • navigationconnect.trips.get

لمزيد من المعلومات، يُرجى الاطّلاع على مستندات "إدارة الهوية وإمكانية الوصول".

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}
route_polyline_format

RoutePolylineFormat

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

RoutePolylineFormat

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

عمليات التعداد
ROUTE_POLYLINE_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق خطوط المسار المتعددة.
SIMPLE يتم عرض خطوط مسار متعدّدة الأضلاع كمصفوفة بسيطة من النقاط الممثّلة على النحو google.type.LatLng.
ENCODED يتم عرض خطوط مسار متعدّدة الأضلاع كسلسلة مرمّزة. يمكنك الاطّلاع على https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED يتم ترميز الخطوط المتعددة للمسار على شكل S2Polyline. يمكنك الاطّلاع على https://s2geometry.io/devguide/basic_types.html.
GEO_JSON يتم عرض خطوط مسار الرحلة المتعددة كـ GeoJSON LineString. يمكنك الاطّلاع على https://tools.ietf.org/html/rfc7946#section-3.1.4.

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

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

الحقول
point

LatLng

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

Timestamp

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

Timestamp

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

مسار

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

الحقول
traffic_information[]

SpeedReadingInterval

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

NOTES:

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

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

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

SimplePolyline

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

string

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

bytes

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

Struct

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

SimplePolyline

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

الحقول
points[]

LatLng

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

SpeedReadingInterval

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

الحقول
speed

Speed

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

int32

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

int32

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

السرعة

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

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

إيقاف

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

الحقول
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 تعذّر إكمال الرحلة بسبب خطأ في البرنامج.
CANCELED تم إلغاء الرحلة صراحةً من قِبل المطوّر.

TripConfig

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

الحقول
enable_high_frequency_updates

bool

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

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

bool

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

FieldMask

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

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

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

  • android_app_id
  • ios_app_id
  • auth_token
  • config

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

bool

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

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

TripExecution

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

الحقول
origin

Location

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

Stop

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

Location

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

Route

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

Duration

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

Duration

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

int32

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

int32

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

bool

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