Package google.maps.routing.v2

فهرست

مسیرها

API مسیرها.

محاسبه مسیر ماتریس

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 در ماسک فیلد خود وارد کنید، زیرا در غیر این صورت همه پیام‌ها بدون مشکل به نظر می‌رسند. گوگل استفاده از ماسک فیلد پاسخ با کاراکترهای وایلدکارد ( * ) را توصیه نمی‌کند، زیرا:

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

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

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

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

درخواست ComputeRouteMatrix

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

فیلدها
origins[]

RouteMatrixOrigin

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

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

RouteMatrixDestination

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

travel_mode

RouteTravelMode

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

routing_preference

RoutingPreference

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

departure_time

Timestamp

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

arrival_time

Timestamp

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

language_code

string

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

region_code

string

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

units

Units

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

extra_computations[]

ExtraComputation

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

traffic_model

TrafficModel

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

transit_preferences

TransitPreferences

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

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

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

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

درخواست مسیر محاسباتی

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

فیلدها
origin

Waypoint

الزامی. نقطه مسیر مبدا.

destination

Waypoint

الزامی. نقطه مسیر مقصد.

intermediates[]

Waypoint

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

travel_mode

RouteTravelMode

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

routing_preference

RoutingPreference

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

polyline_quality

PolylineQuality

اختیاری. ترجیح شما برای کیفیت چندخطی را مشخص می‌کند.

polyline_encoding

PolylineEncoding

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

departure_time

Timestamp

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

arrival_time

Timestamp

اختیاری. زمان رسیدن. توجه: این فیلد زمانی که درخواست‌ها RouteTravelMode دیگری غیر از TRANSIT را مشخص می‌کنند، نادیده گرفته می‌شود. می‌توانید departure_time یا arrival_time مشخص کنید، اما نمی‌توانید هر دو را با هم داشته باشید. سفرهای ترانزیتی تا ۷ روز گذشته یا ۱۰۰ روز آینده در دسترس هستند.

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 پارامترهای مختلفی را در نظر می‌گیرد که یک مسیر بهینه با مصرف سوخت بهینه ایجاد می‌کنند. هنگام استفاده از این ویژگی، به دنبال route_labels در مسیرهای حاصل باشید.

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 تنظیم شده باشد.

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

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

انوم‌ها
EXTRA_COMPUTATION_UNSPECIFIED استفاده نمی‌شود. درخواست‌های حاوی این مقدار با شکست مواجه می‌شوند.
TOLLS اطلاعات عوارض برای مسیر(ها).
FUEL_CONSUMPTION مصرف سوخت تخمینی برای مسیر(ها).
TRAFFIC_ON_POLYLINE چندخطی‌های آگاه از ترافیک برای مسیر(ها).
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions به صورت یک رشته متن HTML قالب‌بندی شده ارائه می‌شوند. این محتوا باید به همان شکلی که هست خوانده شود. این محتوا فقط برای نمایش است. آن را به صورت برنامه‌نویسی تجزیه نکنید.
FLYOVER_INFO_ON_POLYLINE اطلاعات پرواز برای مسیر(ها). برای بازگرداندن این اطلاعات، باید فیلد ماسک routes.polyline_details.flyover_info مشخص شود. این داده‌ها در حال حاضر فقط برای برخی از متروهای هند پر می‌شوند. این ویژگی آزمایشی است و SKU/هزینه ممکن است تغییر کند.
NARROW_ROAD_INFO_ON_POLYLINE اطلاعات جاده باریک برای مسیر(ها). برای بازگرداندن این اطلاعات، باید فیلدماسک routes.polyline_details.narrow_road_info مشخص شود. این داده‌ها در حال حاضر فقط برای برخی از متروهای هند پر می‌شوند. این ویژگی آزمایشی است و SKU/هزینه ممکن است تغییر کند.

مسیر مرجع

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

انوم‌ها
REFERENCE_ROUTE_UNSPECIFIED استفاده نشده است. درخواست‌های حاوی این مقدار با شکست مواجه می‌شوند.
FUEL_EFFICIENT مسیر با مصرف سوخت بهینه.
SHORTER_DISTANCE

مسیری با مسافت سفر کوتاه‌تر. این یک ویژگی آزمایشی است.

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

برای درخواست‌های BICYCLE و TWO_WHEELER ، این ویژگی مسیرهایی مشابه مسیرهایی که در صورت عدم تعیین requested_reference_routes برمی‌گرداند، برمی‌گرداند.

این ویژگی با هیچ حالت سفر دیگری، از طریق نقاط مسیر میانی یا optimize_waypoint_order سازگار نیست؛ چنین درخواست‌هایی با شکست مواجه خواهند شد. با این حال، می‌توانید از آن با هر routing_preference استفاده کنید.

پاسخ‌های ComputeRoutes

پیام پاسخ را ComputeRoutes می‌کند.

فیلدها
routes[]

Route

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

fallback_info

FallbackInfo

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

geocoding_results

GeocodingResults

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

اطلاعات جایگزین

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

فیلدها
routing_mode

FallbackRoutingMode

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

reason

FallbackReason

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

دلیل جایگزین

دلایل استفاده از پاسخ جایگزین

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

حالت مسیریابی بازگشتی

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

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

نقطه مسیر جغرافیایی

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

فیلدها
geocoder_status

Status

کد وضعیت حاصل از عملیات ژئوکدینگ را نشان می‌دهد.

type[]

string

نوع(های) نتیجه، به شکل صفر یا چند برچسب نوع. انواع پشتیبانی شده: انواع آدرس و انواع مؤلفه آدرس .

partial_match

bool

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

place_id

string

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

intermediate_waypoint_request_index

int32

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

نتایج کدگذاری جغرافیایی

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

فیلدها
origin

GeocodedWaypoint

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

destination

GeocodedWaypoint

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

intermediates[]

GeocodedWaypoint

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

زمان محلی

توصیف محلی از زمان.

فیلدها
time

LocalizedText

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

time_zone

string

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

مکان

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

فیلدها
lat_lng

LatLng

مختصات جغرافیایی محل مورد نظر.

heading

Int32Value

جهت قطب‌نما که با جهت جریان ترافیک مرتبط است. این مقدار، سمت جاده را برای سوار و پیاده کردن مسافر مشخص می‌کند. مقادیر جهت می‌توانند از ۰ تا ۳۶۰ باشند، که در آن ۰ جهت شمال، ۹۰ جهت شرق و غیره را مشخص می‌کند. شما می‌توانید از این فیلد فقط برای DRIVE و TWO_WHEELER RouteTravelMode استفاده کنید.

مانور

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

انوم‌ها
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

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

پلی‌لاین

یک چندخطی کدگذاری شده را کپسوله سازی می کند.

فیلدها
فیلد Union polyline_type . نوع چندخطی را کپسوله‌سازی می‌کند. مقدار پیش‌فرض آن encoded_polyline است. polyline_type فقط می‌تواند یکی از موارد زیر باشد:
encoded_polyline

string

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

geo_json_linestring

Struct

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

جزئیات چندخطی

جزئیات مربوط به یک اندیس یا بخش پیوسته از یک چندخطی. با توجه به یک چندخطی با نقاط P_0، P_1، ...، P_N (اندیس مبتنی بر صفر)، PolylineDetails یک بازه و فراداده مرتبط را تعریف می‌کند.

فیلدها
flyover_info[]

FlyoverInfo

جزئیات پل هوایی در امتداد چندخطی.

narrow_road_info[]

NarrowRoadInfo

جزئیات جاده باریک در امتداد پلی‌لاین.

اطلاعات پرواز

اطلاعات مربوط به پل‌های هوایی در امتداد پلی‌لاین را کپسوله‌سازی می‌کند.

فیلدها
flyover_presence

RoadFeatureState

فقط خروجی. نشان می‌دهد که آیا برای یک بخش مشخص از چندخطی، پل هوایی وجود دارد یا خیر.

polyline_point_index

PolylinePointIndex

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

اطلاعات جاده باریک

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

فیلدها
narrow_road_presence

RoadFeatureState

فقط خروجی. نشان می‌دهد که آیا یک جاده باریک برای یک بخش مشخص از چندخطی وجود دارد یا خیر.

polyline_point_index

PolylinePointIndex

اطلاعات مربوط به موقعیت جاده باریک در امتداد چندخطی.

PolylinePointIndex

اندیس‌های شروع و پایان را برای جزئیات چندخطی کپسوله‌سازی می‌کند. برای مواردی که داده‌ها مربوط به یک نقطه واحد هستند، start_index و end_index برابر خواهند بود.

فیلدها
start_index

int32

اندیس شروع این جزئیات در چندخطی.

end_index

int32

اندیس انتهایی این جزئیات در چندخطی.

وضعیت جاده

حالت‌های ویژگی‌های جاده را در امتداد یک چندخطی محصور می‌کند.

انوم‌ها
ROAD_FEATURE_STATE_UNSPECIFIED وضعیت عارضه جاده محاسبه نشده است (مقدار پیش‌فرض).
EXISTS ویژگی جاده وجود دارد.
DOES_NOT_EXIST ویژگی جاده وجود ندارد.

رمزگذاری چندخطی

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

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

کیفیت چندخطی

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

انوم‌ها
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 تنظیم کنید، این فیلد شامل ترتیب بهینه شده نقاط بین‌راهی میانی است. در غیر این صورت، این فیلد خالی است. برای مثال، اگر ورودی مبدا: لس‌آنجلس؛ نقاط بین‌راهی میانی: دالاس، بنگور، فینیکس؛ مقصد: نیویورک؛ و ترتیب بهینه نقطه بین‌راهی میانی، فینیکس، دالاس، بنگور باشد، این فیلد شامل مقادیر [2، 0، 1] است. اندیس برای اولین نقطه بین‌راهی میانی ارائه شده در ورودی با 0 شروع می‌شود.

localized_values

RouteLocalizedValues

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

route_token

string

یک توکن مبهم که می‌تواند به Navigation SDK منتقل شود تا مسیر را در حین ناوبری بازسازی کند و در صورت تغییر مسیر، هدف اصلی هنگام ایجاد مسیر را رعایت کند. با این توکن به عنوان یک توده مبهم رفتار کنید. مقدار آن را در درخواست‌های مختلف مقایسه نکنید زیرا ممکن است مقدار آن تغییر کند، حتی اگر سرویس دقیقاً همان مسیر را برگرداند.

نکته: Route.route_token فقط برای درخواست‌هایی در دسترس است که ComputeRoutesRequest.routing_preference را روی TRAFFIC_AWARE یا TRAFFIC_AWARE_OPTIMAL تنظیم کرده‌اند. Route.route_token برای درخواست‌هایی که دارای نقاط مسیر Via هستند پشتیبانی نمی‌شود.

polyline_details

PolylineDetails

حاوی اطلاعاتی در مورد جزئیات در امتداد چندخطی است.

مقادیر محلی مسیر

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

فیلدها
distance

LocalizedText

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

duration

LocalizedText

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

static_duration

LocalizedText

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

transit_fare

LocalizedText

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

برچسب مسیر

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

انوم‌ها
ROUTE_LABEL_UNSPECIFIED پیش‌فرض - استفاده نمی‌شود.
DEFAULT_ROUTE مسیر پیش‌فرض «بهترین» مسیر برای محاسبه‌ی مسیر برگردانده شده است.
DEFAULT_ROUTE_ALTERNATE جایگزینی برای مسیر پیش‌فرض "بهترین". مسیرهایی مانند این، زمانی که compute_alternative_routes مشخص شده باشد، بازگردانده می‌شوند.
FUEL_EFFICIENT مسیر با مصرف سوخت بهینه. مسیرهایی که با این مقدار برچسب‌گذاری شده‌اند، برای پارامترهای زیست‌محیطی مانند مصرف سوخت بهینه شده‌اند.
SHORTER_DISTANCE مسیر کوتاه‌تر برای طی کردن مسافت. این یک ویژگی آزمایشی است.

مسیر

شامل بخشی بین نقاط مسیر غیر 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

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

مراحلبررسی اجمالی

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

فیلدها
multi_modal_segments[]

MultiModalSegment

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

چندبخشی

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

فیلدها
navigation_instruction

NavigationInstruction

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

travel_mode

RouteTravelMode

شیوه سفر در بخش چندوجهی.

step_start_index

int32

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

step_end_index

int32

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

مسیرقدم

شامل بخشی از یک RouteLeg است. یک مرحله (step) مربوط به یک دستورالعمل ناوبری واحد است. شاخه‌های مسیر (routeleg) از مراحل (steps) تشکیل شده‌اند.

فیلدها
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

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

مقادیر محلی‌شده‌ی مسیر (RouteLegStep)

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

فیلدها
distance

LocalizedText

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

static_duration

LocalizedText

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

جزئیات مسیر و گام

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

فیلدها
stop_details

TransitStopDetails

اطلاعات مربوط به ایستگاه‌های ورود و خروج برای پله.

localized_values

TransitDetailsLocalizedValues

نمایش متنی ویژگی‌های RouteLegStepTransitDetails .

headsign

string

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

headway

Duration

زمان مورد انتظار را به عنوان مدت زمان بین حرکت از یک ایستگاه در این زمان مشخص می‌کند. برای مثال، با مقدار ۶۰۰ ثانیه برای سرفاصله زمانی، اگر اتوبوس خود را از دست بدهید، انتظار می‌رود ده دقیقه منتظر بمانید.

transit_line

TransitLine

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

stop_count

int32

تعداد ایستگاه‌ها از مبدا تا مقصد. این تعداد شامل ایستگاه مقصد می‌شود، اما ایستگاه مبدا را شامل نمی‌شود. برای مثال، اگر مسیر شما از ایستگاه A حرکت می‌کند، از ایستگاه‌های B و C عبور می‌کند و به ایستگاه D می‌رسد،

stop_count

۳ را برمی‌گرداند.

trip_short_text

string

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

جزئیات حمل و نقلمقادیر محلی

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

فیلدها
arrival_time

LocalizedTime

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

departure_time

LocalizedTime

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

جزئیات ایستگاه حمل و نقل

جزئیات مربوط به ایستگاه‌های حمل و نقل عمومی برای RouteLegStep .

فیلدها
arrival_stop

TransitStop

اطلاعات مربوط به ایستگاه ورود برای پله.

arrival_time

Timestamp

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

departure_stop

TransitStop

اطلاعات مربوط به ایستگاه حرکت برای پله.

departure_time

Timestamp

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

مشاوره سفر RouteLegStep

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

فیلدها
speed_reading_intervals[]

SpeedReadingInterval

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

مشاوره سفر RouteLeg

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

فیلدها
toll_info

TollInfo

شامل اطلاعاتی در مورد عوارض جاده‌ای در RouteLeg خاص است. این فیلد فقط در صورتی پر می‌شود که انتظار داشته باشیم عوارضی در RouteLeg وجود داشته باشد و TOLLS در ComputeRoutesRequest.extra_computations درخواست گنجانده شده باشد. اگر این فیلد تنظیم شده باشد اما زیرفیلد estimated_price پر نشده باشد، انتظار داریم که جاده شامل عوارض باشد اما قیمت تخمینی آن را نمی‌دانیم. اگر toll_info وجود نداشته باشد، هیچ عوارضی در RouteLeg وجود ندارد.

speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals indicating traffic density. This field is only populated for requests when the request has a TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routing_preference value, and TRAFFIC_ON_POLYLINE is included in the ComputeRoutesRequest.extra_computations . The intervals cover the entire polyline of the RouteLeg 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).

RouteMatrixDestination

A single destination for ComputeRouteMatrixRequest

فیلدها
waypoint

Waypoint

Required. Destination waypoint

RouteMatrixElement

Contains route information computed for an origin/destination pair in the ComputeRouteMatrix API. This proto can be streamed to the client.

فیلدها
status

Status

Error status code for this element.

condition

RouteMatrixElementCondition

Indicates whether the route was found or not. Independent of status.

distance_meters

int32

The travel distance of the route, in meters.

duration

Duration

The length of time needed to navigate the route. If you set the routing_preference to TRAFFIC_UNAWARE , then this value is the same as static_duration . If you set the routing_preference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL , then this value is calculated taking traffic conditions into account.

static_duration

Duration

The duration of traveling through the route without taking traffic conditions into consideration.

travel_advisory

RouteTravelAdvisory

Additional information about the route. For example: restriction information and toll information

fallback_info

FallbackInfo

In some cases when the server is not able to compute the route with the given preferences for this particular origin/destination pair, it may fall back to using a different mode of computation. When fallback mode is used, this field contains detailed information about the fallback response. Otherwise this field is unset.

localized_values

LocalizedValues

Text representations of properties of the RouteMatrixElement .

origin_index

int32

Zero-based index of the origin in the request.

destination_index

int32

Zero-based index of the destination in the request.

LocalizedValues

Text representations of certain properties.

فیلدها
distance

LocalizedText

Travel distance represented in text form.

duration

LocalizedText

Duration represented in text form taking traffic conditions into consideration. Note: If traffic information was not requested, this value is the same value as static_duration.

static_duration

LocalizedText

Duration represented in text form without taking traffic conditions into consideration.

transit_fare

LocalizedText

Transit fare represented in text form.

RouteMatrixElementCondition

The condition of the route being returned.

انوم‌ها
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED Only used when the status of the element is not OK.
ROUTE_EXISTS A route was found, and the corresponding information was filled out for the element.
ROUTE_NOT_FOUND No route could be found. Fields containing route information, such as distance_meters or duration , will not be filled out in the element.

RouteMatrixOrigin

A single origin for ComputeRouteMatrixRequest

فیلدها
waypoint

Waypoint

Required. Origin waypoint

route_modifiers

RouteModifiers

Optional. Modifiers for every route that takes this as the origin

RouteModifiers

Encapsulates a set of optional conditions to satisfy when calculating the routes.

فیلدها
avoid_tolls

bool

When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_highways

bool

When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_ferries

bool

When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the DRIVE and TWO_WHEELER RouteTravelMode .

avoid_indoor

bool

When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the WALK RouteTravelMode .

vehicle_info

VehicleInfo

Specifies the vehicle information.

toll_passes[]

TollPass

Encapsulates information about toll passes. 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 and TOLLS is included in the request's ComputeRoutesRequest.extra_computations . If this field is set, but the estimatedPrice subfield is not populated, then the route contains tolls, but the estimated price is unknown. If toll_info is not set, then there are no tolls expected on the route.

speed_reading_intervals[]

SpeedReadingInterval

Speed reading intervals indicating traffic density. This field is only populated for requests when the request has a TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routing_preference value, and TRAFFIC_ON_POLYLINE is included in the ComputeRoutesRequest.extra_computations . 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. This field is only populated when FUEL_CONSUMPTION is included in the request's ComputeRoutesRequest.extra_computations .

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.

انوم‌ها
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.

انوم‌ها
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 . The type of speed in this interval. speed_type can be only one of the following:
speed

Speed

Traffic speed in this interval.

سرعت

The classification of polyline speed based on traffic data.

انوم‌ها
SPEED_UNSPECIFIED Default value. This value is unused.
NORMAL Normal speed, no traffic delays.
SLOW Slowdown detected, medium amount of traffic.
TRAFFIC_JAM Traffic delays.

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.

انوم‌ها
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 هند.
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 مکزیک
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

This field specifies one of the following assumptions to use when calculating travel time in traffic conditions, shown in the enums below. Depending on the enum chosen, the duration field of the TrafficModel response will vary. The value contains the predicted time to destination in traffic, based on historical averages. TrafficModel is only available for requests that have set RoutingPreference to TRAFFIC_AWARE_OPTIMAL and RouteTravelMode to DRIVE .

انوم‌ها
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.

انوم‌ها
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.

انوم‌ها
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.

انوم‌ها
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.

واحدها

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

انوم‌ها
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 .

انوم‌ها
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 .

نقطه مسیر

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.

navigation_point_token

string

A token that identifies a NavigationPoint , obtained from the SearchDestinations method of the Geocoding API.