Method: computeRoutes

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

הערה: בשיטה הזו צריך לציין מסכה של שדה תגובה בקלט. אפשר לספק את המסכה של שדה התגובה באמצעות פרמטר כתובת ה-URL $fields או fields, או באמצעות כותרת HTTP/gRPC‏ X-Goog-FieldMask (ראו הפרמטרים והכותרות הזמינים של כתובות URL). הערך הוא רשימה של נתיבים של שדות, מופרדים בפסיקים. איך יוצרים את נתיבי השדות

לדוגמה, בשיטה הזו:

  • אנונימיזציה של כל השדות הזמינים (לבדיקה ידנית): X-Goog-FieldMask: *
  • מסכת שדות של משך הנסיעה, המרחק והקו הפוליגוני ברמת המסלול (דוגמה להגדרה בסביבת הייצור): X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google ממליצה לא להשתמש במסכת השדה של התשובה עם התו הכללי לחיפוש (*), או לציין את מסכת השדה ברמה העליונה (routes), כי:

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

בקשת HTTP

POST https://routes.googleapis.com/directions/v2:computeRoutes

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

גוף הבקשה

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

ייצוג ב-JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "arrivalTime": string,
  "computeAlternativeRoutes": boolean,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "languageCode": string,
  "regionCode": string,
  "units": enum (Units),
  "optimizeWaypointOrder": boolean,
  "requestedReferenceRoutes": [
    enum (ReferenceRoute)
  ],
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "trafficModel": enum (TrafficModel),
  "transitPreferences": {
    object (TransitPreferences)
  }
}
שדות
origin

object (Waypoint)

חובה. ציון הדרך של המקור.

destination

object (Waypoint)

חובה. נקודת ציון ליעד.

intermediates[]

object (Waypoint)

זה שינוי אופציונלי. קבוצה של נקודות דרך לאורך המסלול (לא כולל נקודות קצה), לצורך עצירה או נסיעה חולפת. יש תמיכה בעד 25 נקודות עצירה ביניים.

travelMode

enum (RouteTravelMode)

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

routingPreference

enum (RoutingPreference)

זה שינוי אופציונלי. מציין איך לחשב את המסלול. השרת מנסה להשתמש בעדיפות הניתוב שנבחרה כדי לחשב את המסלול. אם העדפת הניתוב גורמת לשגיאה או לזמן אחזור ארוך במיוחד, תוחזר שגיאה. אפשר לציין את האפשרות הזו רק כאשר הערך של travelMode הוא DRIVE או TWO_WHEELER, אחרת הבקשה תיכשל.

polylineQuality

enum (PolylineQuality)

זה שינוי אופציונלי. מציין את ההעדפה שלכם לגבי איכות הקווים הפוליגונים.

polylineEncoding

enum (PolylineEncoding)

זה שינוי אופציונלי. מציין את קידוד הפוליגון המועדף.

departureTime

string (Timestamp format)

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

חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

arrivalTime

string (Timestamp format)

זה שינוי אופציונלי. שעת ההגעה. הערה: אפשר להגדיר את השדה הזה רק אם הערך של RouteTravelMode הוא TRANSIT. אפשר לציין departureTime או arrivalTime, אבל לא את שניהם. נסיעות בתחבורה ציבורית זמינות עד 7 ימים בעבר או 100 ימים בעתיד.

חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

computeAlternativeRoutes

boolean

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

routeModifiers

object (RouteModifiers)

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

languageCode

string

זה שינוי אופציונלי. קוד השפה לפי BCP-47, למשל 'en-US' או 'sr-Latn'. מידע נוסף זמין במאמר מזהה המקום (locale) של Unicode. ברשימת תמיכת השפות מפורטות השפות הנתמכות. אם לא מציינים את הערך הזה, שפת התצוגה נובעת מהמיקום של בקשת המסלול.

regionCode

string

זה שינוי אופציונלי. קוד האזור, שמצוין כערך בן שני תווים של דומיין ברמה עליונה עם קוד מדינה (ccTLD). מידע נוסף זמין במאמר דומיינים ברמה העליונה עם קוד מדינה.

units

enum (Units)

זה שינוי אופציונלי. מציין את יחידות המידה של שדות התצוגה. השדות האלה כוללים את השדה instruction ב-NavigationInstruction. יחידות המידה שמשמשות למסלול, לשלב, למרחק של שלב ולמשך הזמן לא מושפעות מהערך הזה. אם לא מציינים את הערך הזה, יחידות התצוגה נגזרות מהמיקום של המקור הראשון.

optimizeWaypointOrder

boolean

זה שינוי אופציונלי. אם הערך מוגדר כ-true, השירות ינסה למזער את העלות הכוללת של המסלול על ידי שינוי הסדר של נקודות העצירה הביניים שצוינו. הבקשה נכשלת אם אחד מנקודות הציון הביניים הוא נקודת ציון מסוג via. משתמשים ב-ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index כדי למצוא את הסדר החדש. אם לא מבקשים את ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index בכותרת X-Goog-FieldMask, הבקשה נכשלת. אם optimizeWaypointOrder מוגדר כ-false, השדה ComputeRoutesResponse.optimized_intermediate_waypoint_index יהיה ריק.

requestedReferenceRoutes[]

enum (ReferenceRoute)

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

extraComputations[]

enum (ExtraComputation)

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

trafficModel

enum (TrafficModel)

זה שינוי אופציונלי. ההנחות שישמשו לחישוב הזמן בפקקים. ההגדרה הזו משפיעה על הערך שמוחזר בשדה duration ב-Route וב-RouteLeg, שמכיל את משך הזמן המשוער בתנועה על סמך ממוצעים היסטוריים. TrafficModel זמין רק לבקשות שבהן RoutingPreference מוגדר כ-TRAFFIC_AWARE_OPTIMAL ו-RouteTravelMode מוגדר כ-DRIVE. ערך ברירת המחדל הוא BEST_GUESS אם מבקשים נתוני תנועה ולא מציינים את TrafficModel.

transitPreferences

object (TransitPreferences)

זה שינוי אופציונלי. העדפות שמשפיעות על המסלול שמוחזר למסלולים מסוג TRANSIT. הערה: אפשר לציין transitPreferences רק כשהערך של RouteTravelMode הוא TRANSIT.

גוף התשובה

v2.computeRoutes את הודעת התגובה.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON
{
  "routes": [
    {
      object (Route)
    }
  ],
  "fallbackInfo": {
    object (FallbackInfo)
  },
  "geocodingResults": {
    object (GeocodingResults)
  }
}
שדות
routes[]

object (Route)

מכיל מערך של מסלולים מחושבים (עד שלושה) כשמציינים את compute_alternatives_routes, ומכיל מסלול אחד בלבד אם לא מציינים אותו. אם המערך הזה מכיל כמה רשומות, המסלול הראשון הוא המסלול המומלץ ביותר. אם המערך ריק, המשמעות היא שלא נמצא מסלול.

fallbackInfo

object (FallbackInfo)

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

geocodingResults

object (GeocodingResults)

מכיל את פרטי התגובה של הגיאוקודינג לנקודות ציון שצוינו ככתובות.

PolylineQuality

קבוצת ערכים שמציינים את האיכות של קו הפוליגון.

טיפוסים בני מנייה (enum)
POLYLINE_QUALITY_UNSPECIFIED לא צוינה העדפה לאיכות קווים פוליגונים. ברירת המחדל היא OVERVIEW.
HIGH_QUALITY מציין קו פוליגון באיכות גבוהה – שנוצר באמצעות יותר נקודות מאשר OVERVIEW, בתמורה לגודל תגובה גדול יותר. משתמשים בערך הזה כשצריך יותר דיוק.
OVERVIEW מציין קו פוליגון של סקירה כללית – שנוצר באמצעות מספר קטן של נקודות. משתמשים בערך הזה כשמציגים סקירה כללית של המסלול. כשמשתמשים באפשרות הזו, זמן האחזור של הבקשה קצר יותר בהשוואה לשימוש באפשרות HIGH_QUALITY.

PolylineEncoding

מציין את סוג הקווים המחוברים המועדף שיוחזר.

טיפוסים בני מנייה (enum)
POLYLINE_ENCODING_UNSPECIFIED לא צוינה העדפה לסוג קו פוליגון. ברירת המחדל היא ENCODED_POLYLINE.
ENCODED_POLYLINE מציין קו פוליגון שמקודד באמצעות אלגוריתם הקידוד של קו פוליגון.
GEO_JSON_LINESTRING מציין קו פתוח באמצעות פורמט GeoJSON LineString

ReferenceRoute

מסלול עזר נתמך ב-ComputeRoutesRequest.

טיפוסים בני מנייה (enum)
REFERENCE_ROUTE_UNSPECIFIED לא בשימוש. בקשות שמכילות את הערך הזה נכשלות.
FUEL_EFFICIENT מסלול חסכוני בדלק.
SHORTER_DISTANCE

מסלול עם מרחק נסיעה קצר יותר. זוהי תכונה ניסיונית.

בבקשות מסוג DRIVE, התכונה הזו נותנת עדיפות למרחק קצר יותר על פני נוחות הנסיעה. לדוגמה, יכול להיות שהיא תעדיף דרכים מקומיות במקום כבישים מהירים, דרכים עפר, נסיעה דרך חניונים וכו'. התכונה הזו לא מחזירה תמרון שמערכת מפות Google יודעת שהוא לא חוקי.

בבקשות BICYCLE ו-TWO_WHEELER, התכונה הזו מחזירה מסלולים דומים לאלה שמוחזרים כשלא מציינים את requestedReferenceRoutes.

התכונה הזו לא תואמת לאף אמצעי נסיעה אחר, לנתיב עם נקודות עצירה ביניים או ל-optimizeWaypointOrder. בקשות כאלה ייכשל. עם זאת, אפשר להשתמש בו עם כל routingPreference.

ExtraComputation

חישובים נוספים לביצוע במהלך השלמת הבקשה.

טיפוסים בני מנייה (enum)
EXTRA_COMPUTATION_UNSPECIFIED לא בשימוש. בקשות שמכילות את הערך הזה ייכשל.
TOLLS פרטי האגרה במסלולים.
FUEL_CONSUMPTION צריכת הדלק המשוערת במסלולים.
TRAFFIC_ON_POLYLINE קווים פוליגונים עם מידע על מצב התנועה במסלולים.
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS NavigationInstructions מוצג כמחרוזת טקסט בפורמט HTML. התוכן הזה נועד לקריאה כפי שהוא. התוכן הזה מיועד לתצוגה בלבד. אין לנתח אותו באופן פרוגרמטי.

נתיב

מכיל מסלול, שמורכב מסדרה של קטעי כביש מחוברים שמחברים בין נקודות דרך בתחילת המסלול, בסוף המסלול ובנקודות ביניים.

ייצוג ב-JSON
{
  "routeLabels": [
    enum (RouteLabel)
  ],
  "legs": [
    {
      object (RouteLeg)
    }
  ],
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "description": string,
  "warnings": [
    string
  ],
  "viewport": {
    object (Viewport)
  },
  "travelAdvisory": {
    object (RouteTravelAdvisory)
  },
  "optimizedIntermediateWaypointIndex": [
    integer
  ],
  "localizedValues": {
    object (RouteLocalizedValues)
  },
  "routeToken": string
}
שדות
routeLabels[]

enum (RouteLabel)

תוויות של Route שיעזרו לכם לזהות מאפיינים ספציפיים של המסלול כדי להשוות אותם למאפיינים של מסלולים אחרים.

legs[]

object (RouteLeg)

אוסף של שלבים (קטעי נתיב בין נקודות ציון) שמרכיבים את המסלול. כל מקטע תואם לנסיעה בין שני Waypoints שאינם via. לדוגמה, למסלול ללא נקודות ציון ביניים יש רק שלב אחד. למסלול שכולל נקודת ציון ביניים אחת שאינה via יש שתי רגליים. למסלול שכולל נקודת ציון ביניים אחת מסוג via יש רגל אחת. סדר השלבים תואם לסדר של נקודות הדרך מ-origin ל-intermediates ל-destination.

distanceMeters

integer

מרחק הנסיעה במסלול, במטרים.

duration

string (Duration format)

משך הזמן הנדרש לנסיעה במסלול. אם מגדירים את routingPreference כ-TRAFFIC_UNAWARE, הערך הזה זהה ל-staticDuration. אם מגדירים את routingPreference לערך TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, הערך הזה מחושב תוך התחשבות בתנאי התנועה.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

staticDuration

string (Duration format)

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

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

polyline

object (Polyline)

הקו הפוליגוני הכולל של המסלול. קו הפוליגון הזה הוא קו הפוליגון המשולב של כל legs.

description

string

תיאור המסלול.

warnings[]

string

מערך של אזהרות שיוצגו כשהמסלול מוצג.

viewport

object (Viewport)

התיבה התוחמת (bounding box) של אזור התצוגה של הקו הפוליגוני.

travelAdvisory

object (RouteTravelAdvisory)

מידע נוסף על המסלול.

optimizedIntermediateWaypointIndex[]

integer

אם מגדירים את optimizeWaypointOrder כ-true, השדה הזה מכיל את הסדר המותאם של נקודות ציון ביניים. אחרת, השדה הזה יהיה ריק. לדוגמה, אם מזינים את הפרטים הבאים: מקור: תל אביב; נקודות דרך ביניים: ירושלים, חיפה, תל אביב; יעד: ניו יורק, והסדר האופטימלי של נקודות הדרך הביניים הוא תל אביב, ירושלים, חיפה, השדה הזה יכיל את הערכים [2, 0, 1]. האינדקס מתחיל ב-0 לנקודת הציון הראשונה שצוינה בקלט.

localizedValues

object (RouteLocalizedValues)

ייצוגים של מאפיינים של Route בטקסט.

routeToken

string

אסימון אטום שאפשר להעביר ל-Navigation SDK כדי לשחזר את המסלול במהלך הניווט, ובמקרה של שינוי מסלול, לשמור על הכוונה המקורית שלכם כשיצרתם את המסלול. מתייחסים לאסימון הזה כאל blob אטום. אין להשוות את הערך שלו בין בקשות שונות, כי הערך עשוי להשתנות גם אם השירות מחזיר את אותו מסלול בדיוק.

הערה: השדה Route.route_token זמין רק לבקשות שבהן הערך של ComputeRoutesRequest.routing_preference מוגדר כ-TRAFFIC_AWARE או כ-TRAFFIC_AWARE_OPTIMAL. אין תמיכה ב-Route.route_token בבקשות עם נקודות דרך מסוג 'דרך'.

RouteLabel

תוויות של Route שיעזרו לכם לזהות מאפיינים ספציפיים של המסלול כדי להשוות אותם למאפיינים של מסלולים אחרים.

טיפוסים בני מנייה (enum)
ROUTE_LABEL_UNSPECIFIED ברירת מחדל – לא בשימוש.
DEFAULT_ROUTE מסלול ברירת המחדל 'הטוב ביותר' שהוחזר לחישוב המסלול.
DEFAULT_ROUTE_ALTERNATE חלופה למסלול ברירת המחדל 'הטוב ביותר'. מסלולים כאלה יחזרו כאשר computeAlternativeRoutes יצוין.
FUEL_EFFICIENT מסלול חסכוני בדלק. מסלולים שמסומנים בערך הזה עוברים אופטימיזציה לפי פרמטרים של נסיעה חסכונית, כמו צריכת דלק.
SHORTER_DISTANCE מסלול עם מרחק נסיעה קצר יותר. זוהי תכונה ניסיונית.

RouteLeg

מכיל קטע בין נקודות דרך שאינן מסוג via.

ייצוג ב-JSON
{
  "distanceMeters": integer,
  "duration": string,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "steps": [
    {
      object (RouteLegStep)
    }
  ],
  "travelAdvisory": {
    object (RouteLegTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegLocalizedValues)
  },
  "stepsOverview": {
    object (StepsOverview)
  }
}
שדות
distanceMeters

integer

מרחק הנסיעה של מקטע המסלול, במטרים.

duration

string (Duration format)

משך הזמן הנדרש לניווט במסלול. אם השדה route_preference מוגדר כ-TRAFFIC_UNAWARE, הערך הזה זהה לערך של staticDuration. אם הערך של route_preference הוא TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, הערך הזה מחושב תוך התחשבות בתנאי התנועה.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

staticDuration

string (Duration format)

משך הנסיעה במסלול, ללא התחשבות בתנאי התנועה.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

polyline

object (Polyline)

הקו המרובע הכולל של הקטע הזה, שכולל את הקו המרובע של כל step.

startLocation

object (Location)

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

endLocation

object (Location)

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

steps[]

object (RouteLegStep)

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

travelAdvisory

object (RouteLegTravelAdvisory)

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

localizedValues

object (RouteLegLocalizedValues)

ייצוגים של מאפיינים של RouteLeg בטקסט.

stepsOverview

object (StepsOverview)

מידע כללי על השלבים בRouteLeg הזה. השדה הזה מתמלא רק עבור מסלולי תחבורה ציבורית.

מצולע פתוח

תיבת תכולה של קו מרובה (polyline) מקודד.

ייצוג ב-JSON
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string,
  "geoJsonLinestring": {
    object
  }
  // End of list of possible types for union field polyline_type.
}
שדות
שדה האיחוד polyline_type. מכיל את סוג הקו המרובה. ברירת המחדל היא encoded_polyline. הערך של polyline_type יכול להיות רק אחת מהאפשרויות הבאות:
encodedPolyline

string

קידוד המחרוזת של הקווים המקבילים באמצעות אלגוריתם הקידוד של הקווים המקבילים

geoJsonLinestring

object (Struct format)

מציין קו פתוח באמצעות פורמט GeoJSON LineString.

RouteLegStep

מכיל מקטע של RouteLeg. שלב אחד תואם להוראת ניווט אחת. השלבים בנתיב מורכבים מקטעים.

ייצוג ב-JSON
{
  "distanceMeters": integer,
  "staticDuration": string,
  "polyline": {
    object (Polyline)
  },
  "startLocation": {
    object (Location)
  },
  "endLocation": {
    object (Location)
  },
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelAdvisory": {
    object (RouteLegStepTravelAdvisory)
  },
  "localizedValues": {
    object (RouteLegStepLocalizedValues)
  },
  "transitDetails": {
    object (RouteLegStepTransitDetails)
  },
  "travelMode": enum (RouteTravelMode)
}
שדות
distanceMeters

integer

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

staticDuration

string (Duration format)

משך הנסיעה בשלב הזה, בלי להביא בחשבון את תנאי התנועה. בנסיבות מסוימות, יכול להיות שלא יהיה ערך בשדה הזה.

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

polyline

object (Polyline)

קו הפוליגון שמשויך לשלב הזה.

startLocation

object (Location)

מיקום ההתחלה של השלב הזה.

endLocation

object (Location)

מיקום הסיום של השלב הזה.

navigationInstruction

object (NavigationInstruction)

הוראות ניווט.

travelAdvisory

object (RouteLegStepTravelAdvisory)

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

localizedValues

object (RouteLegStepLocalizedValues)

ייצוגים של מאפיינים של RouteLegStep בטקסט.

transitDetails

object (RouteLegStepTransitDetails)

פרטים לגבי השלב הזה אם אופן הנסיעה הוא TRANSIT.

travelMode

enum (RouteTravelMode)

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

תמרון

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

טיפוסים בני מנייה (enum)
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 משמש לציון שינוי בשם הרחוב.

RouteLegStepTravelAdvisory

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

ייצוג ב-JSON
{
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
שדות
speedReadingIntervals[]

object (SpeedReadingInterval)

הערה: השדה הזה לא מאוכלס כרגע.

RouteLegStepLocalizedValues

ייצוגים של טקסט של נכסים מסוימים.

ייצוג ב-JSON
{
  "distance": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
שדות
distance

object (LocalizedText)

מרחק הנסיעה שמוצג בטקסט.

staticDuration

object (LocalizedText)

משך הנסיעה ללא התחשבות בתנאי התנועה, שמוצג בטקסט.

RouteLegStepTransitDetails

מידע נוסף על RouteLegStep שקשור למסלולים של TRANSIT.

ייצוג ב-JSON
{
  "stopDetails": {
    object (TransitStopDetails)
  },
  "localizedValues": {
    object (TransitDetailsLocalizedValues)
  },
  "headsign": string,
  "headway": string,
  "transitLine": {
    object (TransitLine)
  },
  "stopCount": integer,
  "tripShortText": string
}
שדות
stopDetails

object (TransitStopDetails)

מידע על תחנות היציאה וההגעה של השלב.

localizedValues

object (TransitDetailsLocalizedValues)

ייצוגים של מאפיינים של RouteLegStepTransitDetails בטקסט.

headsign

string

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

headway

string (Duration format)

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

משך הזמן בשניות, עם עד תשע ספרות עשרוניות, שמסתיימים ב-'s'. דוגמה: "3.5s".

transitLine

object (TransitLine)

מידע על קו התחבורה הציבורית שבו השתמשתם בשלב הזה.

stopCount

integer

מספר התחנות מהתחנה המוצאת ועד התחנה שבה מגיעים. הספירה הזו כוללת את תחנת הגעתו, אבל לא כוללת את תחנת היציאה. לדוגמה, אם המסלול יוצא מתחנה א', עובר דרך תחנות ב' ו-ג' ומגיע לתחנה ד',

stopCount

הפונקציה מחזירה את הערך 3.

tripShortText

string

הטקסט שמופיע בלוחות הזמנים ובשלטי הנסיעה כדי לזהות נסיעה בתחבורה ציבורית לנוסעים. הטקסט צריך לזהות באופן ייחודי נסיעה בתוך יום שירות. לדוגמה, '538' הוא tripShortText של רכבת Amtrak שיוצאת מסן חוזה, קליפורניה בשעה 15:10 בימי חול לכיוון סקרמנטו, קליפורניה.

TransitStopDetails

פרטים על תחנות התחבורה הציבורית של קו RouteLegStep.

ייצוג ב-JSON
{
  "arrivalStop": {
    object (TransitStop)
  },
  "arrivalTime": string,
  "departureStop": {
    object (TransitStop)
  },
  "departureTime": string
}
שדות
arrivalStop

object (TransitStop)

מידע על תחנת העצירה של השלב.

arrivalTime

string (Timestamp format)

זמן ההגעה המשוער של השלב.

חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

departureStop

object (TransitStop)

מידע על תחנת היציאה של השלב.

departureTime

string (Timestamp format)

מועד המראה המשוער של השלב.

חותמת זמן בפורמט UTC "Zulu" של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

TransitStop

מידע על תחנה של תחבורה ציבורית.

ייצוג ב-JSON
{
  "name": string,
  "location": {
    object (Location)
  }
}
שדות
name

string

השם של תחנת התחבורה הציבורית.

location

object (Location)

המיקום של התחנה, שמצוין בקואורדינטות של קו רוחב/אורך.

TransitDetailsLocalizedValues

תיאורים מותאמים לשוק המקומי של ערכים של RouteTransitDetails.

ייצוג ב-JSON
{
  "arrivalTime": {
    object (LocalizedTime)
  },
  "departureTime": {
    object (LocalizedTime)
  }
}
שדות
arrivalTime

object (LocalizedTime)

הזמן בפורמט טקסט עם אזור זמן תואם.

departureTime

object (LocalizedTime)

הזמן בפורמט טקסט עם אזור זמן תואם.

LocalizedTime

תיאור מקומי של הזמן.

ייצוג ב-JSON
{
  "time": {
    object (LocalizedText)
  },
  "timeZone": string
}
שדות
time

object (LocalizedText)

השעה שצוינה כמחרוזת באזור זמן נתון.

timeZone

string

מכיל את אזור הזמן. הערך הוא שם אזור הזמן כפי שהוא מוגדר במסד הנתונים של אזור הזמן IANA, למשל 'America/New_York'.

TransitLine

מכיל מידע על קו התחבורה הציבורית שבו נעשה שימוש בשלב הזה.

ייצוג ב-JSON
{
  "agencies": [
    {
      object (TransitAgency)
    }
  ],
  "name": string,
  "uri": string,
  "color": string,
  "iconUri": string,
  "nameShort": string,
  "textColor": string,
  "vehicle": {
    object (TransitVehicle)
  }
}
שדות
agencies[]

object (TransitAgency)

חברת התחבורה הציבורית (או החברות) שמפעילה את קו התחבורה הציבורית הזה.

name

string

השם המלא של קו התחבורה הציבורית. לדוגמה, '8 Avenue Local'.

uri

string

כתובת ה-URI של קו התחבורה הציבורית הזה, כפי שסופקה על ידי חברת התחבורה הציבורית.

color

string

הצבע הנפוץ בסמלי הדרך של הקו הזה. מיוצגים בפורמט הקסדצימלי.

iconUri

string

ה-URI של הסמל שמשויך לשורה הזו.

nameShort

string

השם המקוצר של קו התחבורה הציבורית הזה. בדרך כלל השם הזה יהיה מספר שורה, כמו 'M7' או '355'.

textColor

string

הצבע הנפוץ בטקסט של השילוט של הקו הזה. מיוצגים בפורמט הקסדצימלי.

vehicle

object (TransitVehicle)

סוג הרכב שפועל בקווי התחבורה הציבורית האלה.

TransitAgency

חברת תחבורה ציבורית שמפעילה קו תחבורה ציבורית.

ייצוג ב-JSON
{
  "name": string,
  "phoneNumber": string,
  "uri": string
}
שדות
name

string

השם של חברת התחבורה הציבורית.

phoneNumber

string

מספר הטלפון של חברת התחבורה הציבורית בפורמט שמותאם לאזור.

uri

string

ה-URI של חברת התחבורה הציבורית.

TransitVehicle

מידע על כלי רכב שנעשה בו שימוש במסלולי תחבורה ציבורית.

ייצוג ב-JSON
{
  "name": {
    object (LocalizedText)
  },
  "type": enum (TransitVehicleType),
  "iconUri": string,
  "localIconUri": string
}
שדות
name

object (LocalizedText)

השם של הרכב, באותיות רישיות.

type

enum (TransitVehicleType)

סוג הרכב שבו נעשה שימוש.

iconUri

string

ה-URI של סמל שמשויך לסוג הרכב הזה.

localIconUri

string

ה-URI של הסמל המשויך לסוג הרכב הזה, על סמך סמלי התחבורה המקומית.

TransitVehicleType

סוג כלי התחבורה במסלולי התחבורה הציבורית.

טיפוסים בני מנייה (enum)
TRANSIT_VEHICLE_TYPE_UNSPECIFIED לא בשימוש.
BUS אוטובוס.
CABLE_CAR כלי רכב שפועל באמצעות כבל, בדרך כלל על הקרקע. רכבלים יכולים להיות מסוג GONDOLA_LIFT.
COMMUTER_TRAIN רכבת פרברים.
FERRY מעבורת.
FUNICULAR רכב שנגרר במעלה מדרון תלול באמצעות כבל. בדרך כלל, רכבל מורכב משני קרונות, כאשר כל קרון משמש כמשקל נגד לקרון השני.
GONDOLA_LIFT רכבל.
HEAVY_RAIL רכבת כבדה.
HIGH_SPEED_TRAIN רכבת מהירה.
INTERCITY_BUS אוטובוס בין-עירוני.
LONG_DISTANCE_TRAIN רכבת למרחקים ארוכים.
METRO_RAIL רכבת קלה.
MONORAIL רכבת מונורייל.
OTHER כל שאר כלי הרכב.
RAIL רכבת.
SHARE_TAXI מונית שיתופית היא סוג של אוטובוס עם אפשרות להוריד ולקחת נוסעים בכל מקום במסלול.
SUBWAY רכבת קלה תת-קרקעית.
TRAM רכבת קלה מעל פני השטח.
TROLLEYBUS טרוליבוס.

RouteLegTravelAdvisory

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

ייצוג ב-JSON
{
  "tollInfo": {
    object (TollInfo)
  },
  "speedReadingIntervals": [
    {
      object (SpeedReadingInterval)
    }
  ]
}
שדות
tollInfo

object (TollInfo)

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

speedReadingIntervals[]

object (SpeedReadingInterval)

מרווחים של קריאה מהירה עם פירוט של צפיפות התנועה. רלוונטי במקרה של העדפות ניתוב של TRAFFIC_AWARE ו-TRAFFIC_AWARE_OPTIMAL. המרווחים מכסים את כל קו הפוליגון של RouteLeg ללא חפיפה. נקודת ההתחלה של מרווח זמן מסוים זהה לנקודת הסיום של מרווח הזמן הקודם.

דוגמה:

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

RouteLegLocalizedValues

ייצוגים של טקסט של נכסים מסוימים.

ייצוג ב-JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  }
}
שדות
distance

object (LocalizedText)

מרחק הנסיעה שמוצג בטקסט.

duration

object (LocalizedText)

משך הזמן, שמוצג בטקסט ומותאם לאזור של השאילתה. מביאים בחשבון את מצב התנועה. הערה: אם לא ביקשת מידע על תנועה, הערך הזה יהיה זהה לערך של staticDuration.

staticDuration

object (LocalizedText)

משך הנסיעה ללא התחשבות בתנאי התנועה, שמוצג בטקסט.

StepsOverview

הצגת סקירה כללית של רשימה של RouteLegStep.

ייצוג ב-JSON
{
  "multiModalSegments": [
    {
      object (MultiModalSegment)
    }
  ]
}
שדות
multiModalSegments[]

object (MultiModalSegment)

סיכום של מידע על פלחים שונים של RouteLeg.steps עם מגוון מודלים. השדה הזה לא מאוכלס אם ה-RouteLeg לא מכיל פלחים מרובת-מודלים בשלבים.

MultiModalSegment

מספק מידע מסכם על פלחים שונים של RouteLeg.steps עם כמה מודלים. מקטע רב-מודלי מוגדר כ-RouteLegStep אחד או יותר ברצף שיש להם את אותו RouteTravelMode. השדה הזה לא מאוכלס אם ה-RouteLeg לא מכיל פלחים מרובת-מודלים בשלבים.

ייצוג ב-JSON
{
  "navigationInstruction": {
    object (NavigationInstruction)
  },
  "travelMode": enum (RouteTravelMode),
  "stepStartIndex": integer,
  "stepEndIndex": integer
}
שדות
navigationInstruction

object (NavigationInstruction)

NavigationInstruction לפלח מרובה המצבים.

travelMode

enum (RouteTravelMode)

אמצעי התחבורה של הפלח הרב-מודלי.

stepStartIndex

integer

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

stepEndIndex

integer

האינדקס התואם של RouteLegStep שהוא הסוף של מקטע רב-מודלי.

אזור התצוגה

אזור תצוגה לפי קו הרוחב ואורך הגלובוס, שמיוצג בשתי נקודות low ו-high שממוקמות זו מול זו באלכסון. חלון תצוגה נחשב לאזור סגור, כלומר הוא כולל את הגבול שלו. גבולות קו הרוחב חייבים להיות בטווח של -90 עד 90 מעלות, וגבולות קו האורך חייבים להיות בטווח של -180 עד 180 מעלות. דוגמאות למקרים כאלה:

  • אם low = high, אזור התצוגה מורכב מנקודה אחת.

  • אם low.longitude > high.longitude, טווח קו האורך הפוך (אזור התצוגה חוצה את קו האורך של 180 מעלות).

  • אם low.longitude = -180 מעלות ו-high.longitude = 180 מעלות, חלון התצוגה כולל את כל קוי האורך.

  • אם low.longitude = 180 מעלות ו-high.longitude = -180 מעלות, טווח קו האורך ריק.

  • אם low.latitude > high.latitude, טווח קו הרוחב ריק.

צריך לאכלס את low ואת high, והתיבה שמייצגת אותם לא יכולה להיות ריקה (כפי שצוין בהגדרות שלמעלה). תצוגת חלון ריקה תגרום לשגיאה.

לדוגמה, חלון התצוגה הזה כולל את ניו יורק במלואה:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

ייצוג ב-JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
שדות
low

object (LatLng)

חובה. הנקודה הנמוכה ביותר באזור התצוגה.

high

object (LatLng)

חובה. הנקודה הגבוהה ביותר באזור התצוגה.

RouteLocalizedValues

ייצוגים של טקסט של נכסים מסוימים.

ייצוג ב-JSON
{
  "distance": {
    object (LocalizedText)
  },
  "duration": {
    object (LocalizedText)
  },
  "staticDuration": {
    object (LocalizedText)
  },
  "transitFare": {
    object (LocalizedText)
  }
}
שדות
distance

object (LocalizedText)

מרחק הנסיעה שמוצג בטקסט.

duration

object (LocalizedText)

משך הזמן, שמוצג בטקסט ומותאם לאזור של השאילתה. מביאים בחשבון את מצב התנועה. הערה: אם לא ביקשת מידע על תנועה, הערך הזה זהה לערך של staticDuration.

staticDuration

object (LocalizedText)

משך הנסיעה ללא התחשבות בתנאי התנועה, שמוצג בטקסט.

transitFare

object (LocalizedText)

מחיר הנסיעה בתחבורה הציבורית שמוצג בטקסט.

GeocodingResults

מכיל את הערך GeocodedWaypoints עבור נקודת ההתחלה, היעד ונקודות הביניים. השדה מאוכלס רק בנקודות דרך של כתובות.

ייצוג ב-JSON
{
  "origin": {
    object (GeocodedWaypoint)
  },
  "destination": {
    object (GeocodedWaypoint)
  },
  "intermediates": [
    {
      object (GeocodedWaypoint)
    }
  ]
}
שדות
origin

object (GeocodedWaypoint)

נקודת ציון במקור שהומרו לקואורדינטות.

destination

object (GeocodedWaypoint)

נקודת ציון של יעד שהומרו לקואורדינטות.

intermediates[]

object (GeocodedWaypoint)

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

GeocodedWaypoint

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

ייצוג ב-JSON
{
  "geocoderStatus": {
    object (Status)
  },
  "type": [
    string
  ],
  "partialMatch": boolean,
  "placeId": string,
  "intermediateWaypointRequestIndex": integer
}
שדות
geocoderStatus

object (Status)

קוד הסטטוס שמתקבל מהפעלת הגיאוקודינג.

type[]

string

הסוגים של התוצאה, בצורת אפס תגי סוג או יותר. סוגי הכתובות הנתמכים: סוגי כתובות וסוגי רכיבי כתובות.

partialMatch

boolean

המשמעות היא שהמקודד הגיאוגרפי לא החזיר התאמה מדויקת לבקשה המקורית, אבל הוא הצליח להתאים חלק מהכתובת המבוקשת. מומלץ לבדוק את הבקשה המקורית כדי לראות אם יש בה שגיאות כתיב או כתובת חלקית.

placeId

string

מזהה המקום של התוצאה הזו.

intermediateWaypointRequestIndex

integer

האינדקס של נקודת הציון הביניים התואמת בבקשה. השדה מאוכלס רק אם ציון הדרך התואם הוא ציון דרך ביניים.