Method: computeRoutes

مسیر اصلی بین مبدأ و مقصد درخواست‌شده را برای حالت سفر درخواست‌شده برمی‌گرداند.

درخواست HTTP

POST https://mapstools.googleapis.com/v1:computeRoutes

این نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

متن درخواست

بدنه درخواست حاوی داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
فیلدها
origin

object (Waypoint)

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

object (Waypoint)

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

enum (RouteTravelMode)

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

object (Waypoint)

اختیاری. ایستگاه‌های میانی بین مبدأ و مقصد که باید به‌ترتیب از آن‌ها عبور کرد. حداکثر ۲۵ نقطه‌مسیر میانی پشتیبانی می‌شود.

مشخص کردن بیش‌از ۱۰ نقطه‌مسیر میانی باعث هزینه بیشتر و تأخیر بیشتر می‌شود. وقتی travelMode TRANSIT باشد، نقاط‌مسیر میانی پشتیبانی نمی‌شود.
routingPreference

enum (RoutingPreference)

اختیاری. تعیین می‌کند که چگونه از داده‌های ترافیک برای محاسبه مسیر استفاده شود. وقتی travelMode روی WALK یا BICYCLE باشد، از ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL پشتیبانی نمی‌شود. برای TRANSIT، داده‌های هم‌زمان حمل‌ونقل عمومی را فعال می‌کند، مثل تأخیرها و لغوها.
locationBias

object (LatLng)

اختیاری. مکانی برای سوگیری نتایج جستجو به‌سمت آن، برای مثال برای ابهام‌زدایی پُرسمان‌های نوشتاری نقطه‌مسیر.
includePolyline

boolean

اختیاری. اینکه چندخطی کدگذاری‌شده در مسیرهای پاسخ گنجانده شود یا نه. پیش‌فرض‌ها به false. وقتی روی true تنظیم شود، Route.encoded_polyline برگردانده می‌شود.
computeAlternativeRoutes

boolean

اختیاری. اینکه آیا مسیرهای جایگزین علاوه‌بر مسیر توصیه‌شده محاسبه شود یا نه. به‌طور پیش‌فرض روی false تنظیم شده است که در این صورت فقط مسیر توصیه‌شده برگردانده می‌شود. وقتی روی «درست» تنظیم شود، حداکثر همه مسیرهای دردسترس برگردانده می‌شود، هرچند ممکن است برای هر درخواست، مسیر جایگزین دردسترس نباشد.
مشخص می‌کند چه زمانی از مبدأ حرکت کنید یا به نقطه‌مسیر نهایی برسید. اگر مشخص نشده باشد، به‌طور پیش‌فرض زمان حرکت روی زمان فعلی تنظیم می‌شود. برای TRANSIT، زمان باید حداکثر ۷ روز در گذشته و حداکثر ۱۰۰ روز در آینده باشد. برای دیگر حالت‌های سفر، زمان نباید در گذشته باشد و باید حداکثر ۳۶۵ روز در آینده باشد. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
departureTime

string (Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
arrivalTime

string (Timestamp format)

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

از RFC 3339 استفاده می‌کند، که در آن برونداد تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «Z» نیز پذیرفته می‌شود. مثال‌ها: "2014-10-02T15:01:23Z"، "2014-10-02T15:01:23.045123456Z"، یا "2014-10-02T15:01:23+05:30".
پایان فیلدهای متقابلاً انحصاری.

بدنه پاسخ

اگر موفقیت‌آمیز باشد، بدنه پاسخ حاوی نمونه‌ای از ComputeRoutesResponse است.

دامنه‌های مجوز

به گستره OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/maps-platform.mapstools