Method: computeRoutes

הפונקציה מחזירה את המסלול הראשי בין נקודת המוצא והיעד שביקשתם, בהתאם לאמצעי התחבורה שביקשתם.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-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)

זה שינוי אופציונלי. תחנות ביניים בין נקודת המוצא ליעד שצריך לעבור בהן לפי הסדר. אפשר להוסיף עד 25 נקודות ציון ביניים.

אם תציינו יותר מ-10 ציוני דרך, העלות תהיה גבוהה יותר וזמן האחזור יהיה ארוך יותר. אין תמיכה בנקודות ציון ביניים כשהערך של travelMode הוא TRANSIT.
routingPreference

enum (RoutingPreference)

זה שינוי אופציונלי. קובע איך נתוני התנועה משמשים לחישוב המסלול. אין תמיכה ב-ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL כשהערך של travelMode הוא WALK או BICYCLE. ב-TRANSIT, היא מאפשרת לקבל נתוני תחבורה ציבורית בזמן אמת, כמו עיכובים וביטולים.
locationBias

object (LatLng)

זה שינוי אופציונלי. מיקום להטיית תוצאות החיפוש, למשל כדי להפגת עמימות שאילתות טקסט של ציוני דרך.
includePolyline

boolean

זה שינוי אופציונלי. אם לכלול את הקו הפוליגוני המקודד במסלולי התגובה. ברירת המחדל היא false. כשהערך הוא true, מוחזר הערך Route.encoded_polyline.
computeAlternativeRoutes

boolean

זה שינוי אופציונלי. אם לחשב מסלולים חלופיים בנוסף למסלול המומלץ. ברירת המחדל היא false, ובמקרה כזה מוחזר רק המסלול המומלץ. כשהערך מוגדר כ-true, מוחזרים כל המסלולים הזמינים, אבל יכול להיות שלא יהיו חלופות לכל בקשה.
מציינת מתי לצאת מנקודת המוצא או מתי להגיע לנקודת הציון האחרונה. אם לא מציינים ערך, ברירת המחדל היא יציאה בזמן הנוכחי. בשדה TRANSIT, הזמן חייב להיות עד 7 ימים בעבר ועד 100 ימים בעתיד. באמצעי תחבורה אחרים, השעה לא יכולה להיות בעבר, והיא יכולה להיות עד 365 ימים בעתיד. ברשימה הבאה מפורטים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
departureTime

string (Timestamp format)

זה שינוי אופציונלי. מציין שצריך לחשב את המסלול על סמך שעת היציאה.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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 וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-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