Package google.maps.routing.v2

فهرست مطالب

مسیرها

Routes API.

ComputeRouteMatrix

rpc ComputeRouteMatrix( ComputeRouteMatrixRequest ) returns ( RouteMatrixElement )

فهرستی از مبدا و مقصد را می گیرد و جریانی حاوی اطلاعات مسیر را برای هر ترکیب مبدا و مقصد برمی گرداند.

توجه: این روش مستلزم آن است که یک ماسک فیلد پاسخ را در ورودی مشخص کنید. می‌توانید ماسک فیلد پاسخ را با استفاده از پارامتر URL فیلدها یا fields $fields ، یا با استفاده از هدر HTTP/gRPC X-Goog-FieldMask تهیه کنید (به پارامترها و سرصفحه‌های URL موجود مراجعه کنید). مقدار یک لیست از مسیرهای فیلد جدا شده با کاما است. این مستندات دقیق در مورد نحوه ساخت مسیرهای فیلد را ببینید.

برای مثال در این روش:

  • ماسک فیلد تمام فیلدهای موجود (برای بازرسی دستی): X-Goog-FieldMask: *
  • ماسک میدانی از مدت‌زمان مسیر، مسافت‌ها، وضعیت عنصر، وضعیت و شاخص‌های عنصر (نمونه‌ای از راه‌اندازی تولید): X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

بسیار مهم است که status در ماسک فیلد خود وارد کنید زیرا در غیر این صورت همه پیام‌ها درست به نظر می‌رسند. گوگل استفاده از ماسک فیلد پاسخ ( * ) را منع می کند، زیرا:

  • انتخاب فقط فیلدهایی که نیاز دارید به سرور ما کمک می کند تا چرخه های محاسباتی را ذخیره کند و به ما امکان می دهد نتیجه را با تاخیر کمتری به شما برگردانیم.
  • انتخاب تنها زمینه هایی که در کار تولیدی خود به آن نیاز دارید، عملکرد تاخیر پایدار را تضمین می کند. ممکن است در آینده فیلدهای پاسخ بیشتری اضافه کنیم و این فیلدهای جدید ممکن است به زمان محاسبات اضافی نیاز داشته باشند. اگر همه فیلدها را انتخاب کنید، یا اگر همه فیلدها را در سطح بالا انتخاب کنید، ممکن است با کاهش عملکرد مواجه شوید زیرا هر فیلد جدیدی که اضافه کنیم به طور خودکار در پاسخ گنجانده می شود.
  • انتخاب تنها فیلدهایی که به آنها نیاز دارید باعث می‌شود که اندازه پاسخ کوچک‌تر و در نتیجه توان عملیاتی شبکه بیشتر شود.
ComputeRoutes

rpc ComputeRoutes( ComputeRoutesRequest ) returns ( ComputeRoutesResponse )

با توجه به مجموعه ای از ایستگاه های پایانه و میانی، مسیر اصلی را به همراه مسیرهای جایگزین اختیاری برمی گرداند.

توجه: این روش مستلزم آن است که یک ماسک فیلد پاسخ را در ورودی مشخص کنید. می‌توانید ماسک فیلد پاسخ را با استفاده از پارامتر URL $fields یا fields ، یا با استفاده از هدر HTTP/gRPC X-Goog-FieldMask ارائه دهید (به پارامترها و سرصفحه‌های URL موجود مراجعه کنید). مقدار یک لیست از مسیرهای فیلد جدا شده با کاما است. به مستندات دقیق در مورد نحوه ساخت مسیرهای فیلد مراجعه کنید.

برای مثال در این روش:

  • ماسک فیلد تمام فیلدهای موجود (برای بازرسی دستی): X-Goog-FieldMask: *
  • ماسک فیلد مدت، فاصله و چند خط سطح مسیر (نمونه ای از راه اندازی تولید): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google از استفاده از ماسک فیلد پاسخ ( * ) یا مشخص کردن ماسک فیلد در سطح بالا ( routes ) جلوگیری می کند، زیرا:

  • انتخاب فقط فیلدهایی که نیاز دارید به سرور ما کمک می کند تا چرخه های محاسباتی را ذخیره کند و به ما امکان می دهد نتیجه را با تاخیر کمتری به شما برگردانیم.
  • انتخاب تنها زمینه هایی که در کار تولیدی خود به آن نیاز دارید، عملکرد تاخیر پایدار را تضمین می کند. ممکن است در آینده فیلدهای پاسخ بیشتری اضافه کنیم و این فیلدهای جدید ممکن است به زمان محاسبات اضافی نیاز داشته باشند. اگر همه فیلدها را انتخاب کنید، یا اگر همه فیلدها را در سطح بالا انتخاب کنید، ممکن است با کاهش عملکرد مواجه شوید زیرا هر فیلد جدیدی که اضافه کنیم به طور خودکار در پاسخ گنجانده می شود.
  • انتخاب تنها فیلدهایی که به آنها نیاز دارید باعث می‌شود که اندازه پاسخ کوچک‌تر و در نتیجه توان عملیاتی شبکه بیشتر شود.

ComputeRouteMatrixRequest

پیام درخواست ComputeRouteMatrix

زمینه های
origins[]

RouteMatrixOrigin

ضروری. آرایه مبدا، که ردیف های ماتریس پاسخ را تعیین می کند. چندین محدودیت اندازه برای اصلی بودن مبدا و مقصد اعمال می شود:

  • مجموع تعداد مبدا + تعداد مقصدهای مشخص شده به عنوان place_id یا address نباید بیشتر از 50 باشد.
  • حاصل ضرب تعداد مبدا × تعداد مقصد در هر صورت نباید بیشتر از 625 باشد.
  • اگر routing_preference روی TRAFFIC_AWARE_OPTIMAL تنظیم شده باشد، حاصل ضرب تعداد مبدا × تعداد مقصد نباید بیشتر از 100 باشد.
  • حاصل ضرب تعداد مبدا × تعداد مقصدها نباید بیشتر از 100 باشد اگر travel_mode روی TRANSIT تنظیم شده باشد.
destinations[]

RouteMatrixDestination

ضروری. آرایه ای از مقاصد، که ستون های ماتریس پاسخ را تعیین می کند.

travel_mode

RouteTravelMode

اختیاری. نحوه حمل و نقل را مشخص می کند.

routing_preference

RoutingPreference

اختیاری. نحوه محاسبه مسیر را مشخص می کند. سرور سعی می کند از اولویت مسیریابی انتخاب شده برای محاسبه مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تاخیر طولانی مدت شود، یک خطا برگردانده می شود. شما می توانید این گزینه را فقط زمانی مشخص کنید که travel_mode DRIVE یا TWO_WHEELER باشد، در غیر این صورت درخواست با شکست مواجه می شود.

departure_time

Timestamp

اختیاری. زمان حرکت اگر این مقدار را تنظیم نکنید، این مقدار به طور پیش‌فرض روی زمانی است که درخواست را انجام داده‌اید. توجه: زمانی که RouteTravelMode روی TRANSIT تنظیم شده باشد، می‌توانید departure_time را در گذشته مشخص کنید.

arrival_time

Timestamp

اختیاری. زمان رسیدن. توجه: فقط زمانی می توان تنظیم کرد که RouteTravelMode روی TRANSIT تنظیم شده باشد. شما می توانید departure_time یا arrival_time را مشخص کنید، اما نه هر دو را.

language_code

string

اختیاری. کد زبان BCP-47، مانند "en-US" یا "sr-Latn". برای اطلاعات بیشتر، به شناسه محلی یونیکد مراجعه کنید. برای لیست زبان های پشتیبانی شده به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمی کنید، زبان نمایش از محل مبدا اول استنباط می شود.

region_code

string

اختیاری. کد منطقه که به عنوان یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") مشخص شده است. برای اطلاعات بیشتر به دامنه های سطح بالای کد کشور مراجعه کنید.

extra_computations[]

ExtraComputation

اختیاری. فهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ بازگرداند. این فیلدهای اضافی نیز باید در فیلد ماسک برای بازگشت در پاسخ مشخص شوند.

traffic_model

TrafficModel

اختیاری. مفروضاتی را برای محاسبه زمان در ترافیک مشخص می کند. این تنظیم بر مقدار بازگشتی در قسمت مدت زمان در RouteMatrixElement که شامل زمان پیش‌بینی‌شده در ترافیک بر اساس میانگین‌های تاریخی است، تأثیر می‌گذارد. RoutingPreference به TRAFFIC_AWARE_OPTIMAL و RouteTravelMode به DRIVE . اگر ترافیک درخواست شده باشد و TrafficModel مشخص نشده باشد به BEST_GUESS پیش‌فرض می‌شود.

transit_preferences

TransitPreferences

اختیاری. تنظیمات برگزیده را مشخص می کند که بر مسیر برگشتی برای مسیرهای TRANSIT تأثیر می گذارد. توجه: فقط زمانی می توانید یک transit_preferences مشخص کنید که RouteTravelMode روی TRANSIT تنظیم شده باشد.

محاسبات اضافی

محاسبات اضافی برای انجام در هنگام تکمیل درخواست.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده. درخواست های حاوی این مقدار با شکست مواجه خواهند شد.
TOLLS اطلاعات عوارض برای عنصر(های) ماتریس.

ComputeRoutesRequest

پیام درخواست ComputeRoutes.

زمینه های
origin

Waypoint

ضروری. نقطه راه مبدأ

destination

Waypoint

ضروری. ایستگاه بین راهی مقصد

intermediates[]

Waypoint

اختیاری. مجموعه ای از ایستگاه های بین راهی در طول مسیر (به استثنای نقاط پایانه)، برای توقف یا عبور. حداکثر 25 ایستگاه بین راهی پشتیبانی می شود.

travel_mode

RouteTravelMode

اختیاری. نحوه حمل و نقل را مشخص می کند.

routing_preference

RoutingPreference

اختیاری. نحوه محاسبه مسیر را مشخص می کند. سرور سعی می کند از اولویت مسیریابی انتخاب شده برای محاسبه مسیر استفاده کند. اگر اولویت مسیریابی منجر به خطا یا تاخیر طولانی مدت شود، یک خطا برگردانده می شود. شما می توانید این گزینه را فقط زمانی مشخص کنید که travel_mode DRIVE یا TWO_WHEELER باشد، در غیر این صورت درخواست با شکست مواجه می شود.

polyline_quality

PolylineQuality

اختیاری. ترجیح شما را برای کیفیت پلی لاین مشخص می کند.

polyline_encoding

PolylineEncoding

اختیاری. رمزگذاری ترجیحی برای چند خط را مشخص می کند.

departure_time

Timestamp

اختیاری. زمان حرکت اگر این مقدار را تنظیم نکنید، این مقدار به طور پیش‌فرض روی زمانی است که درخواست را انجام داده‌اید. توجه: زمانی که RouteTravelMode روی TRANSIT تنظیم شده باشد، می‌توانید departure_time را در گذشته مشخص کنید. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

arrival_time

Timestamp

اختیاری. زمان رسیدن. توجه: فقط زمانی می توان تنظیم کرد که RouteTravelMode روی TRANSIT تنظیم شده باشد. شما می توانید departure_time یا arrival_time را مشخص کنید، اما نه هر دو را. سفرهای ترانزیت تا 7 روز در گذشته یا 100 روز در آینده در دسترس هستند.

compute_alternative_routes

bool

اختیاری. تعیین می کند که آیا مسیرهای جایگزین علاوه بر مسیر محاسبه شود یا خیر. هیچ مسیر جایگزینی برای درخواست هایی که دارای ایستگاه های بین راهی هستند بازگردانده نمی شود.

route_modifiers

RouteModifiers

اختیاری. مجموعه ای از شرایط برای برآورده شدن که بر نحوه محاسبه مسیرها تأثیر می گذارد.

language_code

string

اختیاری. کد زبان BCP-47، مانند "en-US" یا "sr-Latn". برای اطلاعات بیشتر، به شناسه محلی یونیکد مراجعه کنید. برای لیست زبان های پشتیبانی شده به پشتیبانی زبان مراجعه کنید. وقتی این مقدار را ارائه نمی کنید، زبان نمایش از محل درخواست مسیر استنباط می شود.

region_code

string

اختیاری. کد منطقه که به عنوان یک مقدار دو نویسه ccTLD ("دامنه سطح بالا") مشخص شده است. برای اطلاعات بیشتر به دامنه های سطح بالای کد کشور مراجعه کنید.

units

Units

اختیاری. واحدهای اندازه گیری فیلدهای نمایش را مشخص می کند. این فیلدها شامل فیلد instruction در NavigationInstruction است. واحدهای اندازه گیری مورد استفاده برای مسیر، پا، فاصله گام، و مدت زمان تحت تأثیر این مقدار قرار نمی گیرند. اگر این مقدار را ارائه نکنید، واحدهای نمایش از محل مبدا اول استنتاج می شوند.

optimize_waypoint_order

bool

اختیاری. اگر روی true تنظیم شود، سرویس تلاش می کند تا هزینه کلی مسیر را با مرتب کردن مجدد ایستگاه های بین راهی مشخص شده به حداقل برساند. در صورتی که هر یک از ایستگاه های بین راهی یک ایستگاه via راهی باشد، درخواست با شکست مواجه می شود. از ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index برای پیدا کردن سفارش جدید استفاده کنید. اگر ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index در هدر X-Goog-FieldMask درخواست نشود، درخواست با شکست مواجه می شود. اگر optimize_waypoint_order روی false تنظیم شود، ComputeRoutesResponse.optimized_intermediate_waypoint_index خالی خواهد بود.

requested_reference_routes[]

ReferenceRoute

اختیاری. مشخص می کند چه مسیرهای مرجعی علاوه بر مسیر پیش فرض به عنوان بخشی از درخواست محاسبه شود. مسیر مرجع مسیری با هدف محاسبه مسیر متفاوت از مسیر پیش‌فرض است. برای مثال یک محاسبه مسیر مرجع FUEL_EFFICIENT پارامترهای مختلفی را در نظر می گیرد که یک مسیر کارآمد سوخت بهینه ایجاد می کند.

extra_computations[]

ExtraComputation

اختیاری. فهرستی از محاسبات اضافی که ممکن است برای تکمیل درخواست استفاده شود. توجه: این محاسبات اضافی ممکن است فیلدهای اضافی را در پاسخ بازگرداند. این فیلدهای اضافی نیز باید در فیلد ماسک برای بازگشت در پاسخ مشخص شوند.

traffic_model

TrafficModel

اختیاری. مفروضاتی را برای محاسبه زمان در ترافیک مشخص می کند. این تنظیم بر مقدار بازگشتی در قسمت مدت زمان در Route و RouteLeg تأثیر می‌گذارد که شامل زمان پیش‌بینی‌شده در ترافیک بر اساس میانگین‌های تاریخی است. TrafficModel فقط برای درخواست‌هایی در دسترس است که RoutingPreference روی TRAFFIC_AWARE_OPTIMAL و RouteTravelMode را روی DRIVE تنظیم کرده‌اند. اگر ترافیک درخواست شده باشد و TrafficModel مشخص نشده باشد به BEST_GUESS پیش‌فرض می‌شود.

transit_preferences

TransitPreferences

اختیاری. تنظیمات برگزیده را مشخص می کند که بر مسیر برگشتی برای مسیرهای TRANSIT تأثیر می گذارد. توجه: فقط زمانی می توانید یک transit_preferences مشخص کنید که RouteTravelMode روی TRANSIT تنظیم شده باشد.

محاسبات اضافی

محاسبات اضافی برای انجام در هنگام تکمیل درخواست.

Enums
EXTRA_COMPUTATION_UNSPECIFIED استفاده نشده. درخواست های حاوی این مقدار با شکست مواجه خواهند شد.
TOLLS اطلاعات عوارض برای مسیر(های)
FUEL_CONSUMPTION مصرف سوخت تخمینی برای مسیر(های)
TRAFFIC_ON_POLYLINE چند خط آگاه از ترافیک برای مسیر(های)
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions به عنوان یک رشته متن فرمت شده HTML ارائه شده است. این محتوا باید همانطور که هست خوانده شود. این محتوا فقط برای نمایش است. به صورت برنامه نویسی آن را تجزیه نکنید.

ReferenceRoute

یک مسیر مرجع پشتیبانی شده در ComputeRoutesRequest.

Enums
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده. درخواست های حاوی این مقدار با شکست مواجه می شوند.
FUEL_EFFICIENT مسیر مصرف سوخت مسیرهایی که با این مقدار برچسب گذاری شده اند برای پارامترهایی مانند مصرف سوخت بهینه شده اند.

ComputeRoutesResponse

ComputeRoute پیام پاسخ.

زمینه های
routes[]

Route

حاوی آرایه‌ای از مسیرهای محاسبه‌شده (حداکثر سه) زمانی که شما compute_alternatives_routes مشخص می‌کنید، و فقط شامل یک مسیر است، در صورتی که این کار را نکنید. هنگامی که این آرایه حاوی چندین ورودی باشد، اولین مسیر توصیه شده است. اگر آرایه خالی باشد، به این معنی است که هیچ مسیری پیدا نشد.

fallback_info

FallbackInfo

در برخی موارد، زمانی که سرور قادر به محاسبه نتایج مسیر با تمام تنظیمات برگزیده ورودی نیست، ممکن است از روش دیگری برای محاسبه استفاده کند. هنگامی که از حالت بازگشتی استفاده می شود، این فیلد حاوی اطلاعات دقیق در مورد پاسخ بازگشتی است. در غیر این صورت این فیلد تنظیم نشده است.

geocoding_results

GeocodingResults

حاوی اطلاعات پاسخ کدگذاری جغرافیایی برای نقاط راه مشخص شده به عنوان آدرس است.

اطلاعات برگشتی

اطلاعات مربوط به چگونگی و چرایی استفاده از یک نتیجه بازگشتی. اگر این فیلد تنظیم شده باشد، به این معنی است که سرور از یک حالت مسیریابی متفاوت از حالت دلخواه شما به عنوان بازگشت استفاده کرده است.

زمینه های
routing_mode

FallbackRoutingMode

حالت مسیریابی برای پاسخ استفاده می شود. اگر بازگشت مجدد فعال شد، حالت ممکن است با اولویت مسیریابی تنظیم شده در درخواست مشتری اصلی متفاوت باشد.

reason

FallbackReason

دلیل استفاده از پاسخ بازگشتی به جای پاسخ اصلی. این فیلد تنها زمانی پر می شود که حالت بازگشتی فعال شود و پاسخ بازگشتی برگردانده شود.

FallbackReason

دلایل استفاده از پاسخ بازگشتی

Enums
FALLBACK_REASON_UNSPECIFIED دلیل بازگشتی مشخص نشده است.
SERVER_ERROR هنگام محاسبه مسیرها با حالت مسیریابی دلخواه شما، یک خطای سرور رخ داد، اما ما توانستیم نتیجه محاسبه‌شده با حالت جایگزین را برگردانیم.
LATENCY_EXCEEDED ما نتوانستیم محاسبه را با حالت مسیریابی دلخواه شما به موقع به پایان برسانیم، اما توانستیم یک نتیجه محاسبه شده توسط یک حالت جایگزین را برگردانیم.

حالت FallbackRouting

حالت مسیریابی واقعی برای پاسخ بازگشتی برگشتی استفاده می شود.

Enums
FALLBACK_ROUTING_MODE_UNSPECIFIED استفاده نشده.
FALLBACK_TRAFFIC_UNAWARE نشان می دهد که از TRAFFIC_UNAWARE RoutingPreference برای محاسبه پاسخ استفاده شده است.
FALLBACK_TRAFFIC_AWARE نشان می دهد که TRAFFIC_AWARE RoutingPreference برای محاسبه پاسخ استفاده شده است.

GeocedWaypoint

جزئیات در مورد مکان های مورد استفاده به عنوان ایستگاه های بین راه. فقط برای نقاط راه آدرس پر شده است. شامل جزئیاتی در مورد نتایج کدگذاری جغرافیایی به منظور تعیین اینکه آدرس به چه مکانی کدگذاری شده است.

زمینه های
geocoder_status

Status

کد وضعیت حاصل از عملیات کدگذاری جغرافیایی را نشان می دهد.

type[]

string

نوع (های) نتیجه، به صورت تگ های صفر یا بیشتر. انواع پشتیبانی شده: انواع آدرس و انواع اجزای آدرس .

partial_match

bool

نشان می دهد که geocoder مطابقت دقیقی با درخواست اصلی برنگردانده است، اگرچه می تواند بخشی از آدرس درخواستی را مطابقت دهد. ممکن است بخواهید درخواست اصلی برای غلط املایی و/یا آدرس ناقص را بررسی کنید.

place_id

string

شناسه مکان برای این نتیجه.

intermediate_waypoint_request_index

int32

شاخص نقطه میانی مربوطه در درخواست. فقط در صورتی پر می شود که نقطه بین راه مربوطه یک ایستگاه بین راهی باشد.

نتایج جغرافیایی

شامل GeocodedWaypoints برای مبدا، مقصد و ایستگاه های بین راهی. فقط برای نقاط راه آدرس پر شده است.

زمینه های
origin

GeocodedWaypoint

نقطه بین مسیرهای جغرافیایی کد شده مبدا.

destination

GeocodedWaypoint

نقطه گذر جغرافیایی مقصد.

intermediates[]

GeocodedWaypoint

فهرستی از نقاط بین راهی با کدهای جغرافیایی میانی که هر کدام حاوی یک فیلد شاخص است که به ترتیبی که در درخواست مشخص شده است، با موقعیت صفر نقطه راه مطابقت دارد.

LocalizedTime

توصیف موضعی زمان

زمینه های
time

LocalizedText

زمان مشخص شده به عنوان یک رشته در یک منطقه زمانی معین.

time_zone

string

شامل منطقه زمانی است. مقدار، نام منطقه زمانی است که در پایگاه داده منطقه زمانی IANA تعریف شده است، به عنوان مثال "America/New_York".

محل

یک مکان (نقطه جغرافیایی و عنوان اختیاری) را در بر می گیرد.

زمینه های
lat_lng

LatLng

مختصات جغرافیایی نقطه راه.

heading

Int32Value

عنوان قطب نما با جهت جریان ترافیک مرتبط است. این مقدار سمت جاده را برای وانت و تخلیه مشخص می کند. مقادیر سرفصل می تواند از 0 تا 360 باشد، که در آن 0 عنوان شمال را مشخص می کند، 90 عنوان یک عنوان شرق و غیره را مشخص می کند. شما می توانید از این فیلد فقط برای DRIVE و TWO_WHEELER RouteTravelMode استفاده کنید.

مانور

مجموعه‌ای از مقادیر که عمل ناوبری را برای مرحله فعلی مشخص می‌کند (مثلاً گردش به چپ، ادغام یا مستقیم).

Enums
MANEUVER_UNSPECIFIED استفاده نشده.
TURN_SLIGHT_LEFT کمی به سمت چپ بپیچید.
TURN_SHARP_LEFT به شدت به سمت چپ بپیچید.
UTURN_LEFT یک چرخش به چپ انجام دهید.
TURN_LEFT به سمت چپ برو، به سمت چپ برگرد.
TURN_SLIGHT_RIGHT کمی به سمت راست بپیچید.
TURN_SHARP_RIGHT به شدت به سمت راست بپیچید.
UTURN_RIGHT یک دور به راست بپیچید.
TURN_RIGHT بپیچ به راست.
STRAIGHT مستقیم برو.
RAMP_LEFT از سطح شیب دار سمت چپ بروید.
RAMP_RIGHT از رمپ سمت راست بروید.
MERGE ادغام در ترافیک
FORK_LEFT چنگال چپ را بردارید.
FORK_RIGHT چنگال مناسب را بردارید.
FERRY سوار کشتی شوید.
FERRY_TRAIN سوار قطار منتهی به کشتی شوید.
ROUNDABOUT_LEFT در دوربرگردان به چپ بپیچید.
ROUNDABOUT_RIGHT در دوربرگردان به راست بپیچید.
DEPART مانور اولیه
NAME_CHANGE برای نشان دادن تغییر نام خیابان استفاده می شود.

دستورالعمل‌های ناوبری را برای یک RouteLegStep در بر می‌گیرد.

زمینه های
maneuver

Maneuver

دستورالعمل‌های پیمایش مرحله فعلی را در بر می‌گیرد (به عنوان مثال، گردش به چپ، ادغام یا مستقیم). این فیلد تعیین می کند که کدام نماد نمایش داده شود.

instructions

string

دستورالعمل پیمایش در این مرحله

پلی لاین

یک چند خط کدگذاری شده را در بر می گیرد.

زمینه های
فیلد اتحادیه polyline_type . نوع پلی لاین را کپسوله می کند. پیش‌فرض encoded_polyline است. polyline_type می تواند تنها یکی از موارد زیر باشد:
encoded_polyline

string

رمزگذاری رشته چند خط با استفاده از الگوریتم کدگذاری چند خطی

geo_json_linestring

Struct

با استفاده از قالب GeoJSON LineString یک چند خط را مشخص می کند.

PolylineEncoding

نوع ترجیحی چند خطی که باید برگردانده شود را مشخص می کند.

Enums
POLYLINE_ENCODING_UNSPECIFIED هیچ نوع اولویت چند خطی مشخص نشده است. پیش‌فرض ENCODED_POLYLINE است.
ENCODED_POLYLINE چند خطی را مشخص می کند که با استفاده از الگوریتم کدگذاری چند خطی کدگذاری شده است.
GEO_JSON_LINESTRING با استفاده از قالب GeoJSON LineString یک چند خط را مشخص می کند

کیفیت پلی لاین

مجموعه ای از مقادیر که کیفیت چند خط را مشخص می کند.

Enums
POLYLINE_QUALITY_UNSPECIFIED هیچ اولویت کیفیت چند خطی مشخص نشده است. به طور پیش‌فرض به OVERVIEW .
HIGH_QUALITY یک خط چند خطی با کیفیت بالا را مشخص می کند - که با استفاده از نقاط بیشتری نسبت به OVERVIEW ساخته شده است، به قیمت افزایش اندازه پاسخ. زمانی که به دقت بیشتری نیاز دارید از این مقدار استفاده کنید.
OVERVIEW یک چند خط نمای کلی را مشخص می کند - که با استفاده از تعداد کمی از نقاط تشکیل شده است. هنگام نمایش یک نمای کلی از مسیر از این مقدار استفاده کنید. استفاده از این گزینه در مقایسه با استفاده از گزینه HIGH_QUALITY تاخیر درخواست کمتری دارد.

مسیر

شامل یک مسیر است که شامل یک سری از بخش های جاده متصل است که به ایستگاه های ابتدایی، انتهایی و میانی می پیوندند.

زمینه های
route_labels[]

RouteLabel

برچسب‌هایی برای Route که برای شناسایی ویژگی‌های خاص مسیر برای مقایسه با دیگران مفید هستند.

legs[]

RouteLeg

مجموعه ای از پاها (بخش های مسیر بین ایستگاه های بین راه) که مسیر را تشکیل می دهند. هر پا مربوط به سفر بین دو Waypoints غیر از via است. به عنوان مثال، مسیری که هیچ ایستگاه بین راهی ندارد، تنها یک پا دارد. مسیری که شامل یک ایستگاه بین راهی غیر از via است، دو پا دارد. مسیری که شامل یک مسیر via ایستگاه بین راهی است، یک پا دارد. ترتیب پاها با ترتیب ایستگاه های بین راه از origin تا intermediates تا destination مطابقت دارد.

distance_meters

int32

مسافت طی مسیر، بر حسب متر.

duration

Duration

مدت زمان لازم برای پیمایش مسیر. اگر routing_preference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار همان static_duration است. اگر routing_preference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می‌شود.

static_duration

Duration

مدت زمان سفر در مسیر بدون در نظر گرفتن شرایط ترافیکی.

polyline

Polyline

چند خط کلی مسیر. این چند خط، چند خط ترکیبی همه legs است.

description

string

شرح مسیر.

warnings[]

string

مجموعه ای از هشدارها برای نشان دادن هنگام نمایش مسیر.

viewport

Viewport

کادر محدودکننده نما در چند خط.

travel_advisory

RouteTravelAdvisory

اطلاعات تکمیلی در مورد مسیر.

optimized_intermediate_waypoint_index[]

int32

اگر optimize_waypoint_order را روی true تنظیم کنید، این فیلد شامل ترتیب بهینه شده نقاط بین راهی است. در غیر این صورت این قسمت خالی است. برای مثال، اگر ورودی Origin را بدهید: LA; ایستگاه های بین راهی: دالاس، بانگور، فینیکس؛ مقصد: نیویورک؛ و ترتیب میانی بهینه شده Phoenix، Dallas، Bangor است، سپس این فیلد حاوی مقادیر [2، 0، 1] است. شاخص با 0 برای اولین نقطه میانی ارائه شده در ورودی شروع می شود.

localized_values

RouteLocalizedValues

نمایش متنی ویژگی های Route .

route_token

string

یک توکن مسیر ایمن و با کد base64 که می‌تواند به Navigation SDK ارسال شود، که به Navigation SDK اجازه می‌دهد مسیر را در حین پیمایش بازسازی کند و در صورت تغییر مسیر، هنگام ایجاد مسیر با تماس، به هدف اصلی احترام بگذارد. ComputeRoutes. مشتریان باید با این توکن به عنوان یک لکه غیر شفاف برخورد کنند. برای خواندن یا جهش در نظر گرفته نشده است. توجه: Route.route_token فقط برای درخواست‌هایی در دسترس است که ComputeRoutesRequest.routing_preference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کرده‌اند. Route.route_token برای درخواست هایی که دارای ایستگاه های بین راه هستند پشتیبانی نمی شود.

RouteLocalizedValues

نمایش متنی از ویژگی های خاص.

زمینه های
distance

LocalizedText

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

duration

LocalizedText

مدت زمان با در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است. توجه: اگر اطلاعات ترافیک را درخواست نکرده باشید، این مقدار همان مقدار static_duration خواهد بود.

static_duration

LocalizedText

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

transit_fare

LocalizedText

کرایه حمل و نقل به صورت متنی نشان داده شده است.

RouteLabel

برچسب‌هایی برای Route که برای شناسایی ویژگی‌های خاص مسیر برای مقایسه با دیگران مفید هستند.

Enums
ROUTE_LABEL_UNSPECIFIED پیش فرض - استفاده نشده است.
DEFAULT_ROUTE مسیر پیش‌فرض "بهترین" برای محاسبه مسیر برگردانده شد.
DEFAULT_ROUTE_ALTERNATE جایگزینی برای مسیر پیش‌فرض "بهترین" مسیرهایی مانند این زمانی که compute_alternative_routes مشخص شده باشد بازگردانده می شوند.
FUEL_EFFICIENT مسیر مصرف سوخت مسیرهایی که با این مقدار برچسب گذاری شده اند برای پارامترهای Eco مانند مصرف سوخت بهینه شده اند.

RouteLeg

شامل یک بخش بین ایستگاه های غیر از via .

زمینه های
distance_meters

int32

مسافت طی مسیر، بر حسب متر.

duration

Duration

مدت زمان لازم برای حرکت در پا. اگر route_preference روی TRAFFIC_UNAWARE تنظیم شود، این مقدار همان static_duration است. اگر route_preference یا TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL باشد، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می شود.

static_duration

Duration

مدت زمان سفر از طریق پا، بدون در نظر گرفتن شرایط ترافیک محاسبه شده است.

polyline

Polyline

چند خط کلی برای این پا که شامل چند خط هر step است.

start_location

Location

محل شروع این پا. این مکان ممکن است با origin ارائه شده متفاوت باشد. به عنوان مثال، زمانی که origin ارائه شده نزدیک جاده نباشد، این نقطه ای از جاده است.

end_location

Location

محل انتهایی این پا. این مکان ممکن است با destination ارائه شده متفاوت باشد. به عنوان مثال، زمانی که destination ارائه شده نزدیک جاده ای نباشد، این نقطه ای در جاده است.

steps[]

RouteLegStep

مجموعه‌ای از مراحل که بخش‌های درون این پا را نشان می‌دهد. هر مرحله نشان دهنده یک دستورالعمل ناوبری است.

travel_advisory

RouteLegTravelAdvisory

حاوی اطلاعات اضافی است که کاربر باید از آنها مطلع شود، مانند محدودیت های احتمالی منطقه ترافیک، در یک مسیر.

localized_values

RouteLegLocalizedValues

نمایش متنی ویژگی های RouteLeg .

steps_overview

StepsOverview

اطلاعات کلی در مورد مراحل این RouteLeg . این قسمت فقط برای مسیرهای TRANSIT پر شده است.

RouteLegLocalizedValues

نمایش متنی از ویژگی های خاص.

زمینه های
distance

LocalizedText

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

duration

LocalizedText

مدت زمان با در نظر گرفتن شرایط ترافیکی به صورت متن نشان داده شده است. توجه: اگر اطلاعات ترافیک را درخواست نکرده باشید، این مقدار همان مقدار static_duration خواهد بود.

static_duration

LocalizedText

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

StepsOverview

اطلاعات کلی درباره لیستی از RouteLegStep را ارائه می دهد.

زمینه های
multi_modal_segments[]

MultiModalSegment

اطلاعات خلاصه شده در مورد بخش های مختلف چند وجهی RouteLeg.steps . اگر RouteLeg شامل بخش‌های چند وجهی در مراحل نباشد، این فیلد پر نمی‌شود.

MultiModalSegment

اطلاعات خلاصه ای را در مورد بخش های مختلف چند وجهی RouteLeg.steps ارائه می دهد. یک بخش چند وجهی به عنوان یک یا چند RouteLegStep به هم پیوسته تعریف می‌شود که RouteTravelMode یکسان دارند. اگر RouteLeg شامل بخش‌های چند وجهی در مراحل نباشد، این فیلد پر نمی‌شود.

زمینه های
navigation_instruction

NavigationInstruction

راهنمای ناوبری برای بخش چند وجهی.

travel_mode

RouteTravelMode

حالت سفر بخش چند وجهی.

step_start_index

int32

شاخص RouteLegStep مربوطه که شروع یک بخش چند وجهی است.

step_end_index

int32

شاخص RouteLegStep مربوطه که انتهای یک بخش چند وجهی است.

RouteLegStep

شامل بخشی از RouteLeg است. یک مرحله مربوط به یک دستورالعمل ناوبری است. پایه های مسیر از پله ها تشکیل شده است.

زمینه های
distance_meters

int32

مسافت طی این مرحله، بر حسب متر است. در برخی شرایط، این فیلد ممکن است ارزشی نداشته باشد.

static_duration

Duration

مدت زمان سفر در این مرحله بدون در نظر گرفتن شرایط ترافیکی. در برخی شرایط، این فیلد ممکن است ارزشی نداشته باشد.

polyline

Polyline

چند خط مرتبط با این مرحله.

start_location

Location

محل شروع این مرحله.

end_location

Location

محل پایان این مرحله.

navigation_instruction

NavigationInstruction

دستورالعمل های ناوبری.

travel_advisory

RouteLegStepTravelAdvisory

حاوی اطلاعات اضافی است که کاربر باید از آنها مطلع شود، مانند محدودیت های احتمالی منطقه ترافیک، در یک گام.

localized_values

RouteLegStepLocalizedValues

نمایش متنی خصوصیات RouteLegStep .

transit_details

RouteLegStepTransitDetails

جزئیات مربوط به این مرحله اگر حالت سفر TRANSIT باشد.

travel_mode

RouteTravelMode

حالت سفر استفاده شده برای این مرحله.

RouteLegStepLocalizedValues

نمایش متنی از ویژگی های خاص.

زمینه های
distance

LocalizedText

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

static_duration

LocalizedText

مدت زمان بدون در نظر گرفتن شرایط ترافیک، به صورت متن نشان داده شده است.

RouteLegStepTransitDetails

اطلاعات اضافی برای RouteLegStep مربوط به مسیرهای TRANSIT .

زمینه های
stop_details

TransitStopDetails

اطلاعات در مورد ورود و خروج توقف برای مرحله.

localized_values

TransitDetailsLocalizedValues

نمایش متنی خصوصیات RouteLegStepTransitDetails .

headsign

string

جهت حرکت در این خط را همانطور که روی وسیله نقلیه یا در ایستگاه خروج مشخص شده است مشخص می کند. جهت اغلب ایستگاه پایانه است.

headway

Duration

زمان مورد انتظار را به عنوان مدت زمان بین خروج از همان توقف در این زمان مشخص می کند. به عنوان مثال، با مقدار 600 ثانیه پیشروی، اگر اتوبوس خود را از دست بدهید، انتظار دارید ده دقیقه صبر کنید.

transit_line

TransitLine

اطلاعات مربوط به خط ترانزیت مورد استفاده در این مرحله.

stop_count

int32

تعداد توقف ها از مبدأ تا توقف ورود. این شمارش شامل توقف ورود است، اما توقف خروج را شامل نمی شود. به عنوان مثال، اگر مسیر شما از ایستگاه A خارج شود، از ایستگاه های B و C عبور کند و به ایستگاه D برسد، stop_count عدد 3 را برمی گرداند.

trip_short_text

string

متنی که در جدول ها و تابلوهای علامت برای شناسایی یک سفر ترانزیت به مسافران ظاهر می شود. متن باید به طور منحصر به فرد یک سفر در یک روز خدمات را مشخص کند. به عنوان مثال، "538" trip_short_text قطار Amtrak است که سن خوزه، کالیفرنیا را در ساعت 15:10 روزهای هفته به سمت ساکرامنتو، کالیفرنیا ترک می کند.

TransitDetailsLocalizedValues

توضیحات محلی مقادیر برای RouteTransitDetails .

زمینه های
arrival_time

LocalizedTime

زمان در نمایش متن قالب بندی شده با منطقه زمانی مربوطه.

departure_time

LocalizedTime

زمان در نمایش متن قالب بندی شده با منطقه زمانی مربوطه.

TransitStopDetails

جزئیات در مورد توقف های حمل و نقل برای RouteLegStep .

زمینه های
arrival_stop

TransitStop

اطلاعات در مورد توقف رسیدن برای مرحله.

arrival_time

Timestamp

زمان تخمینی رسیدن به مرحله.

departure_stop

TransitStop

اطلاعات در مورد توقف حرکت برای پله.

departure_time

Timestamp

زمان تخمینی حرکت برای مرحله.

RouteLegStepTravelAdvisory

حاوی اطلاعات اضافی است که کاربر باید از آنها مطلع شود، مانند محدودیت های احتمالی منطقه ترافیکی در یک گام پا.

زمینه های
speed_reading_intervals[]

SpeedReadingInterval

توجه: این فیلد در حال حاضر پر نشده است.

RouteLegTravelAdvisory

حاوی اطلاعات اضافی است که کاربر باید در یک پله از آنها مطلع شود، مانند محدودیت های احتمالی منطقه ترافیک.

زمینه های
toll_info

TollInfo

حاوی اطلاعاتی درباره عوارض در RouteLeg خاص است. این فیلد فقط در صورتی پر می شود که انتظار داشته باشیم عوارضی در RouteLeg وجود داشته باشد. اگر این فیلد تنظیم شده باشد اما زیرفیلد تخمینی_قیمت پر نشده باشد، انتظار داریم که جاده شامل عوارض باشد اما قیمت تخمینی را نمی دانیم. اگر این فیلد وجود نداشته باشد، هیچ عوارضی در RouteLeg وجود ندارد.

speed_reading_intervals[]

SpeedReadingInterval

فواصل تندخوانی با جزئیات تراکم ترافیک. قابل اجرا در موارد ترجیحات مسیریابی TRAFFIC_AWARE و TRAFFIC_AWARE_OPTIMAL . فواصل، کل چند خط RouteLeg را بدون همپوشانی پوشش می دهند. نقطه شروع یک بازه مشخص با نقطه پایان بازه قبلی یکسان است.

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speed_reading_intervals: [A,C), [C,D), [D,G).

RouteMatrixDestination

یک مقصد واحد برای ComputeRouteMatrixRequest

زمینه های
waypoint

Waypoint

ضروری. ایستگاه بین راهی مقصد

RouteMatrixElement

حاوی اطلاعات مسیر محاسبه شده برای یک جفت مبدا/مقصد در ComputeRouteMatrix API است. این پروتو را می توان برای مشتری پخش کرد.

زمینه های
status

Status

کد وضعیت خطا برای این عنصر.

condition

RouteMatrixElementCondition

نشان می دهد که آیا مسیر پیدا شده است یا خیر. مستقل از وضعیت

distance_meters

int32

مسافت طی مسیر، بر حسب متر.

duration

Duration

مدت زمان لازم برای پیمایش مسیر. اگر routing_preference را روی TRAFFIC_UNAWARE تنظیم کنید، این مقدار همان static_duration است. اگر routing_preference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کنید، این مقدار با در نظر گرفتن شرایط ترافیک محاسبه می‌شود.

static_duration

Duration

مدت زمان سفر در مسیر بدون در نظر گرفتن شرایط ترافیکی.

travel_advisory

RouteTravelAdvisory

اطلاعات تکمیلی در مورد مسیر. به عنوان مثال: اطلاعات محدودیت و اطلاعات عوارض

fallback_info

FallbackInfo

در برخی موارد که سرور قادر به محاسبه مسیر با ترجیحات داده شده برای این جفت مبدا/مقصد خاص نیست، ممکن است به استفاده از حالت دیگری از محاسبه بازگردد. هنگامی که از حالت بازگشتی استفاده می شود، این قسمت حاوی اطلاعات دقیق در مورد پاسخ بازگشتی است. در غیر این صورت این فیلد تنظیم نشده است.

localized_values

LocalizedValues

نمایش متنی خصوصیات RouteMatrixElement .

origin_index

int32

شاخص مبتنی بر صفر مبدا در درخواست.

destination_index

int32

شاخص مبتنی بر صفر مقصد در درخواست.

Localized Values

نمایش متنی از ویژگی های خاص.

زمینه های
distance

LocalizedText

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

duration

LocalizedText

مدت زمان به صورت متنی با در نظر گرفتن شرایط ترافیک نشان داده می شود. توجه: اگر اطلاعات ترافیک درخواست نشده باشد، این مقدار همان مقدار static_duration است.

static_duration

LocalizedText

مدت زمان به صورت متنی بدون در نظر گرفتن شرایط ترافیک نشان داده می شود.

transit_fare

LocalizedText

کرایه حمل و نقل به صورت متنی نشان داده شده است.

RouteMatrixElementCondition

وضعیت مسیر در حال برگشت.

Enums
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED فقط زمانی استفاده می شود که status عنصر خوب نباشد.
ROUTE_EXISTS یک مسیر پیدا شد و اطلاعات مربوطه برای عنصر پر شد.
ROUTE_NOT_FOUND هیچ مسیری پیدا نشد فیلدهای حاوی اطلاعات مسیر، مانند distance_meters یا duration ، در عنصر پر نمی‌شوند.

RouteMatrixOrigin

یک مبدا واحد برای ComputeRouteMatrixRequest

زمینه های
waypoint

Waypoint

ضروری. نقطه راه مبدأ

route_modifiers

RouteModifiers

اختیاری. اصلاح‌کننده‌ها برای هر مسیری که این را مبدأ می‌گیرد

RouteModifiers

مجموعه ای از شرایط اختیاری را در بر می گیرد تا هنگام محاسبه مسیرها برآورده شوند.

زمینه های
avoid_tolls

bool

وقتی روی true تنظیم شود، در صورت معقول بودن از جاده‌های عوارضی اجتناب می‌کند و به مسیرهایی که شامل جاده‌های عوارضی نیستند، ترجیح می‌دهد. فقط برای DRIVE و TWO_WHEELER RouteTravelMode اعمال می شود.

avoid_highways

bool

وقتی روی true تنظیم شود، از بزرگراه‌هایی که معقول باشد اجتناب می‌کند و به مسیرهایی که شامل بزرگراه نیستند ترجیح می‌دهد. فقط برای DRIVE و TWO_WHEELER RouteTravelMode اعمال می شود.

avoid_ferries

bool

وقتی روی true تنظیم شود، در صورت معقول بودن از کشتی‌ها اجتناب می‌کند و به مسیرهایی که شامل کشتی نیستند ترجیح می‌دهد. فقط برای DRIVE و TWO_WHEELER RouteTravelMode اعمال می شود.

avoid_indoor

bool

وقتی روی true تنظیم شود، از پیمایش در داخل خانه در جایی که معقول باشد اجتناب می‌کند، و ترجیح می‌دهد مسیرهایی که حاوی ناوبری داخلی نیستند. فقط برای WALK RouteTravelMode اعمال می شود.

vehicle_info

VehicleInfo

اطلاعات خودرو را مشخص می کند.

toll_passes[]

TollPass

اطلاعات مربوط به مجوزهای دریافت عوارض را در خود گنجانده است. If toll passes are provided, the API tries to return the pass price. If toll passes are not provided, the API treats the toll pass as unknown and tries to return the cash price. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

RouteTravelAdvisory

Contains the additional information that the user should be informed about, such as possible traffic zone restrictions.

زمینه های
toll_info

TollInfo

Contains information about tolls on the route. This field is only populated if tolls are expected on the route. If this field is set, but the estimatedPrice subfield is not populated, then the route contains tolls, but the estimated price is unknown. If this field is not set, then there are no tolls expected on the route.

speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals detailing traffic density. Applicable in case of TRAFFIC_AWARE and TRAFFIC_AWARE_OPTIMAL routing preferences. The intervals cover the entire polyline of the route without overlap. The start point of a specified interval is the same as the end point of the preceding interval.

مثال:

polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speed_reading_intervals: [A,C), [C,D), [D,G).
fuel_consumption_microliters

int64

The predicted fuel consumption in microliters.

route_restrictions_partially_ignored

bool

Returned route may have restrictions that are not suitable for requested travel mode or route modifiers.

transit_fare

Money

If present, contains the total fare or ticket costs on this route This property is only returned for TRANSIT requests and only for routes where fare information is available for all transit steps.

RouteTravelMode

A set of values used to specify the mode of travel. NOTE: WALK , BICYCLE , and TWO_WHEELER routes are in beta and might sometimes be missing clear sidewalks, pedestrian paths, or bicycling paths. You must display this warning to the user for all walking, bicycling, and two-wheel routes that you display in your app.

Enums
TRAVEL_MODE_UNSPECIFIED No travel mode specified. Defaults to DRIVE .
DRIVE Travel by passenger car.
BICYCLE Travel by bicycle.
WALK Travel by walking.
TWO_WHEELER Two-wheeled, motorized vehicle. For example, motorcycle. Note that this differs from the BICYCLE travel mode which covers human-powered mode.
TRANSIT Travel by public transit routes, where available.

RoutingPreference

A set of values that specify factors to take into consideration when calculating the route.

Enums
ROUTING_PREFERENCE_UNSPECIFIED No routing preference specified. Default to TRAFFIC_UNAWARE .
TRAFFIC_UNAWARE Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For RouteTravelMode DRIVE and TWO_WHEELER , the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.
TRAFFIC_AWARE Calculates routes taking live traffic conditions into consideration. In contrast to TRAFFIC_AWARE_OPTIMAL , some optimizations are applied to significantly reduce latency.
TRAFFIC_AWARE_OPTIMAL Calculates the routes taking live traffic conditions into consideration, without applying most performance optimizations. Using this value produces the highest latency.

SpeedReadingInterval

Traffic density indicator on a contiguous segment of a polyline or path. Given a path with points P_0, P_1, ... , P_N (zero-based index), the SpeedReadingInterval defines an interval and describes its traffic using the following categories.

زمینه های
start_polyline_point_index

int32

The starting index of this interval in the polyline.

end_polyline_point_index

int32

The ending index of this interval in the polyline.

Union field speed_type .

speed_type can be only one of the following:

speed

Speed

Traffic speed in this interval.

Speed

The classification of polyline speed based on traffic data.

Enums
SPEED_UNSPECIFIED مقدار پیش فرض. This value is unused.
NORMAL Normal speed, no slowdown is detected.
SLOW Slowdown detected, but no traffic jam formed.
TRAFFIC_JAM Traffic jam detected.

TollInfo

Encapsulates toll information on a Route or on a RouteLeg .

زمینه های
estimated_price[]

Money

The monetary amount of tolls for the corresponding Route or RouteLeg . This list contains a money amount for each currency that is expected to be charged by the toll stations. Typically this list will contain only one item for routes with tolls in one currency. For international trips, this list may contain multiple items to reflect tolls in different currencies.

TollPass

List of toll passes around the world that we support.

Enums
TOLL_PASS_UNSPECIFIED Not used. If this value is used, then the request fails.
AU_ETOLL_TAG Sydney toll pass. See additional details at https://www.myetoll.com.au .
AU_EWAY_TAG Sydney toll pass. See additional details at https://www.tollpay.com.au .
AU_LINKT Australia-wide toll pass. See additional details at https://www.linkt.com.au/ .
AR_TELEPASE Argentina toll pass. See additional details at https://telepase.com.ar
BR_AUTO_EXPRESO Brazil toll pass. See additional details at https://www.autoexpreso.com
BR_CONECTCAR Brazil toll pass. See additional details at https://conectcar.com .
BR_MOVE_MAIS Brazil toll pass. See additional details at https://movemais.com .
BR_PASSA_RAPIDO Brazil toll pass. See additional details at https://pasorapido.gob.do/
BR_SEM_PARAR Brazil toll pass. See additional details at https://www.semparar.com.br .
BR_TAGGY Brazil toll pass. See additional details at https://taggy.com.br .
BR_VELOE Brazil toll pass. See additional details at https://veloe.com.br/site/onde-usar .
CA_US_AKWASASNE_SEAWAY_CORPORATE_CARD Canada to United States border crossing.
CA_US_AKWASASNE_SEAWAY_TRANSIT_CARD Canada to United States border crossing.
CA_US_BLUE_WATER_EDGE_PASS Ontario, Canada to Michigan, United States border crossing.
CA_US_CONNEXION Ontario, Canada to Michigan, United States border crossing.
CA_US_NEXUS_CARD Canada to United States border crossing.
ID_E_TOLL Indonesia. E-card provided by multiple banks used to pay for tolls. All e-cards via banks are charged the same so only one enum value is needed. Eg - Bank Mandiri https://www.bankmandiri.co.id/e-money - BCA https://www.bca.co.id/flazz - BNI https://www.bni.co.id/id-id/ebanking/tapcash
IN_FASTAG India.
IN_LOCAL_HP_PLATE_EXEMPT India, HP state plate exemption.
JP_ETC Japan ETC. Electronic wireless system to collect tolls. https://www.go-etc.jp/
JP_ETC2 Japan ETC2.0. New version of ETC with further discount and bidirectional communication between devices on vehicles and antennas on the road. https://www.go-etc.jp/etc2/index.html
MX_IAVE Mexico toll pass. https://iave.capufe.gob.mx/#/
MX_PASE Mexico https://www.pase.com.mx
MX_QUICKPASS Mexico https://operadoravial.com/quick-pass/
MX_SISTEMA_TELEPEAJE_CHIHUAHUA http://appsh.chihuahua.gob.mx/transparencia/?doc=/ingresos/TelepeajeFormato4.pdf
MX_TAG_IAVE Mexico
MX_TAG_TELEVIA Mexico toll pass company. One of many operating in Mexico City. See additional details at https://www.televia.com.mx .
MX_TELEVIA Mexico toll pass company. One of many operating in Mexico City. https://www.televia.com.mx
MX_VIAPASS Mexico toll pass. See additional details at https://www.viapass.com.mx/viapass/web_home.aspx .
US_AL_FREEDOM_PASS AL, USA.
US_AK_ANTON_ANDERSON_TUNNEL_BOOK_OF_10_TICKETS AK, USA.
US_CA_FASTRAK CA, USA.
US_CA_FASTRAK_CAV_STICKER Indicates driver has any FasTrak pass in addition to the DMV issued Clean Air Vehicle (CAV) sticker. https://www.bayareafastrak.org/en/guide/doINeedFlex.shtml
US_CO_EXPRESSTOLL CO, USA.
US_CO_GO_PASS CO, USA.
US_DE_EZPASSDE DE, USA.
US_FL_BOB_SIKES_TOLL_BRIDGE_PASS FL, USA.
US_FL_DUNES_COMMUNITY_DEVELOPMENT_DISTRICT_EXPRESSCARD FL, USA.
US_FL_EPASS FL, USA.
US_FL_GIBA_TOLL_PASS FL, USA.
US_FL_LEEWAY FL, USA.
US_FL_SUNPASS FL, USA.
US_FL_SUNPASS_PRO FL, USA.
US_IL_EZPASSIL IL, USA.
US_IL_IPASS IL, USA.
US_IN_EZPASSIN IN, USA.
US_KS_BESTPASS_HORIZON KS, USA.
US_KS_KTAG KS, USA.
US_KS_NATIONALPASS KS, USA.
US_KS_PREPASS_ELITEPASS KS, USA.
US_LA_GEAUXPASS LA, USA.
US_LA_TOLL_TAG LA, USA.
US_MA_EZPASSMA MA, USA.
US_MD_EZPASSMD MD, USA.
US_ME_EZPASSME ME, USA.
US_MI_AMBASSADOR_BRIDGE_PREMIER_COMMUTER_CARD MI, USA.
US_MI_BCPASS MI, USA.
US_MI_GROSSE_ILE_TOLL_BRIDGE_PASS_TAG MI, USA.
US_MI_IQ_PROX_CARD

MI, USA. Deprecated as this pass type no longer exists.

US_MI_IQ_TAG MI, USA.
US_MI_MACKINAC_BRIDGE_MAC_PASS MI, USA.
US_MI_NEXPRESS_TOLL MI, USA.
US_MN_EZPASSMN MN, USA.
US_NC_EZPASSNC NC, USA.
US_NC_PEACH_PASS NC, USA.
US_NC_QUICK_PASS NC, USA.
US_NH_EZPASSNH NH, USA.
US_NJ_DOWNBEACH_EXPRESS_PASS NJ, USA.
US_NJ_EZPASSNJ NJ, USA.
US_NY_EXPRESSPASS NY, USA.
US_NY_EZPASSNY NY, USA.
US_OH_EZPASSOH OH, USA.
US_PA_EZPASSPA PA, USA.
US_RI_EZPASSRI RI, USA.
US_SC_PALPASS SC, USA.
US_TX_AVI_TAG TX, USA.
US_TX_BANCPASS TX, USA.
US_TX_DEL_RIO_PASS TX, USA.
US_TX_EFAST_PASS TX, USA.
US_TX_EAGLE_PASS_EXPRESS_CARD TX, USA.
US_TX_EPTOLL TX, USA.
US_TX_EZ_CROSS TX, USA.
US_TX_EZTAG TX, USA.
US_TX_FUEGO_TAG TX, USA.
US_TX_LAREDO_TRADE_TAG TX, USA.
US_TX_PLUSPASS TX, USA.
US_TX_TOLLTAG TX, USA.
US_TX_TXTAG TX, USA.
US_TX_XPRESS_CARD TX, USA.
US_UT_ADAMS_AVE_PARKWAY_EXPRESSCARD UT, USA.
US_VA_EZPASSVA VA, USA.
US_WA_BREEZEBY WA, USA.
US_WA_GOOD_TO_GO WA, USA.
US_WV_EZPASSWV WV, USA.
US_WV_MEMORIAL_BRIDGE_TICKETS WV, USA.
US_WV_MOV_PASS WV, USA
US_WV_NEWELL_TOLL_BRIDGE_TICKET WV, USA.

TrafficModel

Specifies the assumptions to use when calculating time in traffic. This setting affects the value returned in the duration field in the response, which contains the predicted time in traffic based on historical averages.

Enums
TRAFFIC_MODEL_UNSPECIFIED Unused. If specified, will default to BEST_GUESS .
BEST_GUESS Indicates that the returned duration should be the best estimate of travel time given what is known about both historical traffic conditions and live traffic. Live traffic becomes more important the closer the departure_time is to now.
PESSIMISTIC Indicates that the returned duration should be longer than the actual travel time on most days, though occasional days with particularly bad traffic conditions may exceed this value.
OPTIMISTIC Indicates that the returned duration should be shorter than the actual travel time on most days, though occasional days with particularly good traffic conditions may be faster than this value.

TransitAgency

A transit agency that operates a transit line.

زمینه های
name

string

The name of this transit agency.

phone_number

string

The transit agency's locale-specific formatted phone number.

uri

string

The transit agency's URI.

TransitLine

Contains information about the transit line used in this step.

زمینه های
agencies[]

TransitAgency

The transit agency (or agencies) that operates this transit line.

name

string

The full name of this transit line, For example, "8 Avenue Local".

uri

string

the URI for this transit line as provided by the transit agency.

color

string

The color commonly used in signage for this line. Represented in hexadecimal.

icon_uri

string

The URI for the icon associated with this line.

name_short

string

The short name of this transit line. This name will normally be a line number, such as "M7" or "355".

text_color

string

The color commonly used in text on signage for this line. Represented in hexadecimal.

vehicle

TransitVehicle

The type of vehicle that operates on this transit line.

TransitPreferences

Preferences for TRANSIT based routes that influence the route that is returned.

زمینه های
allowed_travel_modes[]

TransitTravelMode

A set of travel modes to use when getting a TRANSIT route. Defaults to all supported modes of travel.

routing_preference

TransitRoutingPreference

A routing preference that, when specified, influences the TRANSIT route returned.

TransitRoutingPreference

Specifies routing preferences for transit routes.

Enums
TRANSIT_ROUTING_PREFERENCE_UNSPECIFIED No preference specified.
LESS_WALKING Indicates that the calculated route should prefer limited amounts of walking.
FEWER_TRANSFERS Indicates that the calculated route should prefer a limited number of transfers.

TransitTravelMode

A set of values used to specify the mode of transit.

Enums
TRANSIT_TRAVEL_MODE_UNSPECIFIED No transit travel mode specified.
BUS Travel by bus.
SUBWAY Travel by subway.
TRAIN Travel by train.
LIGHT_RAIL Travel by light rail or tram.
RAIL Travel by rail. This is equivalent to a combination of SUBWAY , TRAIN , and LIGHT_RAIL .

TransitStop

Information about a transit stop.

زمینه های
name

string

The name of the transit stop.

location

Location

The location of the stop expressed in latitude/longitude coordinates.

TransitVehicle

Information about a vehicle used in transit routes.

زمینه های
name

LocalizedText

The name of this vehicle, capitalized.

type

TransitVehicleType

The type of vehicle used.

icon_uri

string

The URI for an icon associated with this vehicle type.

local_icon_uri

string

The URI for the icon associated with this vehicle type, based on the local transport signage.

TransitVehicleType

The type of vehicles for transit routes.

Enums
TRANSIT_VEHICLE_TYPE_UNSPECIFIED Unused.
BUS Bus.
CABLE_CAR A vehicle that operates on a cable, usually on the ground. Aerial cable cars may be of the type GONDOLA_LIFT .
COMMUTER_TRAIN Commuter rail.
FERRY Ferry.
FUNICULAR A vehicle that is pulled up a steep incline by a cable. A Funicular typically consists of two cars, with each car acting as a counterweight for the other.
GONDOLA_LIFT An aerial cable car.
HEAVY_RAIL Heavy rail.
HIGH_SPEED_TRAIN High speed train.
INTERCITY_BUS Intercity bus.
LONG_DISTANCE_TRAIN Long distance train.
METRO_RAIL Light rail transit.
MONORAIL Monorail.
OTHER All other vehicles.
RAIL Rail.
SHARE_TAXI Share taxi is a kind of bus with the ability to drop off and pick up passengers anywhere on its route.
SUBWAY Underground light rail.
TRAM Above ground light rail.
TROLLEYBUS Trolleybus.

Units

A set of values that specify the unit of measure used in the display.

Enums
UNITS_UNSPECIFIED Units of measure not specified. Defaults to the unit of measure inferred from the request.
METRIC Metric units of measure.
IMPERIAL Imperial (English) units of measure.

VehicleEmissionType

A set of values describing the vehicle's emission type. Applies only to the DRIVE RouteTravelMode .

Enums
VEHICLE_EMISSION_TYPE_UNSPECIFIED No emission type specified. Default to GASOLINE .
GASOLINE Gasoline/petrol fueled vehicle.
ELECTRIC Electricity powered vehicle.
HYBRID Hybrid fuel (such as gasoline + electric) vehicle.
DIESEL Diesel fueled vehicle.

VehicleInfo

Contains the vehicle information, such as the vehicle emission type.

زمینه های
emission_type

VehicleEmissionType

Describes the vehicle's emission type. Applies only to the DRIVE RouteTravelMode .

Waypoint

Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.

زمینه های
via

bool

Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the legs array to provide the details for stopovers on that leg of the trip. Set this value to true when you want the route to pass through this waypoint without stopping over. Via waypoints don't cause an entry to be added to the legs array, but they do route the journey through the waypoint. You can only set this value on waypoints that are intermediates. The request fails if you set this field on terminal waypoints. If ComputeRoutesRequest.optimize_waypoint_order is set to true then this field cannot be set to true; otherwise, the request fails.

vehicle_stopover

bool

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non- via waypoints on roads that are unsuitable for pickup and drop-off. This option works only for DRIVE and TWO_WHEELER travel modes, and when the location_type is Location .

side_of_road

bool

Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for 'DRIVE' and 'TWO_WHEELER' RouteTravelMode .

Union field location_type . Different ways to represent a location. location_type can be only one of the following:
location

Location

A point specified using geographic coordinates, including an optional heading.

place_id

string

The POI Place ID associated with the waypoint.

address

string

Human readable address or a plus code. See https://plus.codes for details.