Package google.maps.navconnect.v1

فهرست

• NavConnectService (رابط)
• AuthToken (پیام)
• CreateTripRequest (پیام)
• GetTripRequest (پیام)
• Location (پیام)
• Stop (پیام)
• Trip (پیام)
• Trip.State (شمارشی)
• TripConfig (پیام)
• TripExecution (پیام)

سرویس اتصال ناوبری

سرویسی برای مشتریان NavConnect جهت ایجاد و دریافت سفرها.

ایجاد سفر
rpc CreateTrip( CreateTripRequest ) returns ( Trip ) یک سفر ایجاد می‌کند. این باید قبل از اینکه برنامه تلفن همراه بتواند سفر را شروع کند، فراخوانی شود. سفر برگشتی فیلد auth_token را خواهد داشت. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/cloud-platform

گت‌تریپ
rpc GetTrip( GetTripRequest ) returns ( Trip ) سفری نصیبش می‌شود. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/cloud-platform

توکن احراز هویت

یک توکن احراز هویت.

فیلدها
token	string فقط خروجی. توکن احراز هویتی که باید به برنامه تلفن همراه منتقل شود.
expire_time	Timestamp فقط خروجی. زمانی که توکن احراز هویت منقضی می‌شود.

درخواست سفر جدید (CreateTripRequest)

درخواست پیام برای NavConnectService.CreateTrip.

فیلدها
parent	string الزامی. منبع والدی که این سفر تحت آن ایجاد خواهد شد. قالب: projects/{project_number}
trip_id	string الزامی. شناسه‌ای که برای سفر استفاده می‌شود، که به جزء نهایی نام منبع سفر تبدیل خواهد شد. این مقدار باید یک UUID معتبر RFC-4122 باشد.
trip	Trip سفری برای خلق کردن. الزامی.

درخواست سفر دریافت کنید

درخواست پیام برای 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_app_id یا ios_app_id باید تنظیم شود.
ios_app_id	string فقط ورودی. تغییرناپذیر. شناسه بسته iOS برنامه تلفن همراه که از سفر استفاده خواهد کرد. حداقل یکی از android_app_id یا ios_app_id باید تنظیم شود.
auth_token	AuthToken فقط خروجی. یک توکن مبهم که دسترسی به شروع یک سفر NavConnect در Google Maps یا Waze را مجاز می‌کند و به این برنامه‌ها دسترسی به‌روزرسانی سفر را می‌دهد. فقط توسط CreateTrip برگردانده می‌شود.
state	State فقط خروجی. حالت تریپ.
execution	TripExecution فقط خروجی. آخرین داده‌ها در مورد اجرای سفر. اگر سفر در حالت خطا باشد، ممکن است این تنظیم نشود.
create_time	Timestamp فقط خروجی. زمان طبق سرور هنگام ایجاد سفر.
update_time	Timestamp فقط خروجی. زمانی که سرور آخرین به‌روزرسانی سفر را دریافت کرده است.

ایالت

تمام حالت‌های ممکن سفر.

انوم‌ها
STATE_UNSPECIFIED	وضعیت سفر مشخص نشده است.
NEW	این سفر ایجاد شده اما هنوز آغاز نشده است.
ENROUTE	حامل در حال حرکت به سمت مقصد است.
ARRIVED	حامل به مقصد رسید.
SUSPENDED	سفر به حالت تعلیق درآمد.
FAILED	این سفر با موفقیت به پایان نرسید.
CLIENT_ERROR	این سفر به دلیل خطای کلاینت با شکست مواجه شد.

تریپ‌کانفیگ

پیکربندی برای سفر.

فیلدها
enable_high_frequency_updates	bool اختیاری. فعال کردن به‌روزرسانی‌های سفرهای پرتکرار. توجه: فعال کردن این ویژگی، سفر را تحت استفاده در سطح سازمانی ثبت می‌کند و مشمول نرخ‌های سطح سازمانی است.
enable_pubsub	bool اختیاری. فعال بودن یا نبودن اعلان‌های pubsub برای سفر.
pubsub_field_mask	FieldMask اختیاری. در صورت تنظیم، فقط زیرمجموعه مشخص‌شده از فیلدهای Trip در اعلان‌های pubsub گنجانده می‌شوند. اگر تنظیم نشود، تمام فیلدهای Trip در اعلان‌های pubsub (رفتار پیش‌فرض) گنجانده می‌شوند. فیلدهای زیر پشتیبانی نمی‌شوند: android_app_id ios_app_id auth_token config نکته: اگر enable_pubsub مقدار false داشته باشد، این فیلد نادیده گرفته می‌شود.

اجرای سفر

داده‌های مربوط به اجرای سفر.

فیلدها
origin	Location فقط خروجی. مبدا سفر که عموماً موقعیت مکانی حمل‌کننده در شروع سفر NavConnect است.
destination	Stop فقط خروجی. مقصد سفر همانطور که توسط برنامه تلفن همراه گزارش شده است.
location	Location فقط خروجی. سیگنال موقعیت مکانی که آخرین موقعیت شناخته شده‌ی وسیله‌ی نقلیه را نشان می‌دهد. در صورت وجود، این موقعیت، موقعیت ثبت شده در جاده خواهد بود.
traveled_duration	Duration فقط خروجی. زمان طی شده تا این حد.
remaining_duration	Duration فقط خروجی. زمان باقی مانده از این سفر طبق تخمین گوگل.
traveled_distance_meters	int32 فقط خروجی. مسافت طی شده از مبدا بر حسب متر.
remaining_distance_meters	int32 فقط خروجی. فاصله باقی مانده تا مقصد بر حسب متر.
stop_added_in_route	bool فقط خروجی. نشان می‌دهد که آیا در طول مسیر توقفی اضافه شده است یا خیر.