- בקשת HTTP
- גוף הבקשה
- גוף התשובה
- PolylineQuality
- PolylineEncoding
- ReferenceRoute
- ExtraComputation
- Route
- RouteLabel
- RouteLeg
- קו פוליגוני
- RouteLegStep
- NavigationInstruction
- תמרון
- RouteLegStepTravelAdvisory
- RouteLegStepLocalizedValues
- RouteLegStepTransitDetails
- TransitStopDetails
- TransitStop
- TransitDetailsLocalizedValues
- LocalizedTime
- TransitLine
- TransitAgency
- TransitVehicle
- TransitVehicleType
- RouteLegTravelAdvisory
- RouteLegLocalizedValues
- StepsOverview
- MultiModalSegment
- Viewport
- RouteLocalizedValues
- PolylineDetails
- TunnelInfo
- RoadFeatureState
- PolylinePointIndex
- RestrictionInfo
- FlyoverInfo
- NarrowRoadInfo
- BridgeInfo
- SkywayInfo
- GeocodingResults
- GeocodedWaypoint
הפונקציה מחזירה את המסלול הראשי יחד עם מסלולים חלופיים אופציונליים, בהינתן קבוצה של נקודות ציון סופיות ונקודות ציון ביניים.
הערה: בשיטה הזו צריך לציין מסכת שדות של תשובה בקלט. אפשר לספק את מסכת שדות התגובה באמצעות פרמטר של כתובת 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 כתובה בתחביר של gRPC Transcoding.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "origin": { object ( |
| שדות | |
|---|---|
origin |
חובה. ציון דרך של נקודת המוצא. |
destination |
חובה. נקודת ציון של היעד. |
intermediates[] |
אופציונלי. קבוצה של נקודות ציון לאורך המסלול (לא כולל נקודות סיום), לעצירה או למעבר. יש תמיכה בעד 25 ציוני דרך. |
travelMode |
אופציונלי. מציין את אמצעי התחבורה. |
routingPreference |
אופציונלי. מציינת איך לחשב את המסלול. השרת מנסה להשתמש בהעדפת הניתוב שנבחרה כדי לחשב את המסלול. אם העדפת הניתוב גורמת לשגיאה או לזמן אחזור ארוך במיוחד, מוחזרת שגיאה. אפשר לציין את האפשרות הזו רק אם הערך של |
polylineQuality |
אופציונלי. מציינת את ההעדפה שלכם לגבי איכות הקו הפוליגוני. |
polylineEncoding |
אופציונלי. מציינת את הקידוד המועדף של הקו הפוליגוני. |
departureTime |
אופציונלי. שעת היציאה. אם לא מגדירים את הערך הזה, ערך ברירת המחדל הוא הזמן שבו שלחתם את הבקשה. הערה: אפשר לציין הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
arrivalTime |
אופציונלי. זמן ההגעה. הערה: המערכת מתעלמת מהשדה הזה אם בבקשות מצוין ערך הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
computeAlternativeRoutes |
אופציונלי. המדיניות הזו קובעת אם לחשב מסלולים חלופיים בנוסף למסלול. לא מוחזרים מסלולים חלופיים לבקשות שכוללות נקודות ציון ביניים. |
routeModifiers |
אופציונלי. קבוצת תנאים שמשפיעים על אופן חישוב המסלולים. |
languageCode |
אופציונלי. קוד השפה בתקן BCP-47, כמו 'en-US' או 'sr-Latn'. מידע נוסף זמין במאמר בנושא מזהה אזור Unicode. כאן אפשר לעיין ברשימת השפות הנתמכות. אם לא מספקים את הערך הזה, שפת התצוגה נקבעת לפי המיקום של בקשת המסלול. |
regionCode |
אופציונלי. קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. מידע נוסף זמין במאמר בנושא דומיינים ברמה העליונה עם קוד מדינה. |
units |
אופציונלי. מגדירה את יחידות המידה של שדות התצוגה. השדות האלה כוללים את השדה |
optimizeWaypointOrder |
אופציונלי. אם המדיניות מוגדרת כ-True, השירות מנסה למזער את העלות הכוללת של המסלול על ידי שינוי הסדר של נקודות הביניים שצוינו. הבקשה נכשלת אם אחת מנקודות הביניים היא נקודת ציון מסוג |
requestedReferenceRoutes[] |
אופציונלי. המדיניות הזו קובעת אילו מסלולי הפניה יחושבו כחלק מהבקשה, בנוסף למסלול ברירת המחדל. מסלול ייחוס הוא מסלול עם מטרה שונה לחישוב המסלול בהשוואה למסלול ברירת המחדל. לדוגמה, בחישוב של מסלול ייחוס |
extraComputations[] |
אופציונלי. רשימה של חישובים נוספים שאולי ישמשו להשלמת הבקשה. הערה: יכול להיות שהחישובים הנוספים האלה יחזירו שדות נוספים בתגובה. צריך לציין את השדות הנוספים האלה גם באנונימיזציה של השדה כדי שהם יוחזרו בתגובה. |
trafficModel |
אופציונלי. מציינת את ההנחות שבהן צריך להשתמש כשמחשבים את הזמן שחלף מאז הכניסה לאתר. ההגדרה הזו משפיעה על הערך שמוחזר בשדה משך הזמן ב- |
transitPreferences |
אופציונלי. ההגדרה הזו מציינת העדפות שמשפיעות על המסלול שמוחזר עבור |
גוף התשובה
v2.computeRoutes הודעת התשובה.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "routes": [ { object ( |
| שדות | |
|---|---|
routes[] |
מכיל מערך של מסלולים מחושבים (עד שלושה) כשמציינים את |
fallbackInfo |
במקרים מסוימים, אם השרת לא מצליח לחשב את תוצאות המסלול עם כל העדפות הקלט, הוא עשוי לחזור לשימוש בדרך חישוב אחרת. כשמשתמשים במצב חלופי, השדה הזה מכיל מידע מפורט על התשובה החלופית. אחרת, השדה הזה לא מוגדר. |
geocodingResults |
מכיל מידע על תגובת המרת כתובות לקואורדינטות (geocoding) לנקודות ציון שצוינו ככתובות. |
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 |
מסלול עם מרחק נסיעה קצר יותר. זו תכונה ניסיונית. בבקשות של עבור בקשות התכונה הזו לא תואמת לאמצעי הגעה אחרים, לא לניווט דרך נקודות ציון ביניים ולא ל |
ExtraComputation
חישובים נוספים שצריך לבצע כדי להשלים את הבקשה. יכול להיות שבעתיד נוסיף עוד ערכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
לא בשימוש. בקשות שמכילות את הערך הזה ייכשלו. |
TOLLS |
מידע על אגרות בכבישים במסלולים. |
FUEL_CONSUMPTION |
צריכת הדלק המשוערת במסלול או במסלולים. |
TRAFFIC_ON_POLYLINE |
קווים פוליגוניים מודעים לתנועה עבור המסלולים. |
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS |
NavigationInstruction מוצג כמחרוזת טקסט בפורמט HTML. התוכן הזה נועד לקריאה כמו שהוא. התוכן הזה מיועד לתצוגה בלבד. אל תנתחו אותו באופן פרוגרמטי. |
FLYOVER_INFO_ON_POLYLINE |
מידע על מעבר מעל המסלול או המסלולים. כדי לקבל את המידע הזה, צריך לציין את routes.polyline_details.flyover_info fieldmask. בשלב הזה, הנתונים האלה יאוכלסו רק לגבי אזורי מטרופולין מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות. |
NARROW_ROAD_INFO_ON_POLYLINE |
מידע על כבישים צרים במסלול או במסלולים. כדי לקבל את המידע הזה, צריך לציין את routes.polyline_details.narrow_road_info fieldmask. בשלב הזה, הנתונים האלה יאוכלסו רק לגבי אזורי מטרופולין מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות. |
TUNNEL_INFO_ON_POLYLINE |
מידע על המנהרה במסלול. כדי לקבל את המידע הזה, צריך לציין את routes.polyline_details.tunnel_info fieldmask. |
BRIDGE_INFO_ON_POLYLINE |
מידע על הגשרים במסלול או במסלולים. כדי לקבל את המידע הזה, צריך לציין את routes.polyline_details.bridge_info fieldmask. |
SKYWAY_INFO_ON_POLYLINE |
מידע על נתיבי אוויר למסלולים. כדי לקבל את המידע הזה, צריך לציין את routes.polyline_details.skyway_info fieldmask. |
מסלול
מכיל מסלול, שמורכב מסדרה של מקטעי כביש מחוברים שמצטרפים לנקודות ציון להתחלה, לסיום ולביניים.
| ייצוג ב-JSON |
|---|
{ "routeLabels": [ enum ( |
| שדות | |
|---|---|
routeLabels[] |
תוויות ל- |
legs[] |
אוסף של קטעי מסלול (קטעי נתיב בין נקודות ציון) שמרכיבים את המסלול. כל קטע טיסה מתאים לנסיעה בין שני יעדים שאינם |
distanceMeters |
מרחק הנסיעה במסלול, במטרים. |
duration |
משך הזמן שנדרש כדי לנווט במסלול. אם מגדירים את משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
staticDuration |
משך הנסיעה במסלול בלי להתחשב במצב התנועה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
polyline |
הקו הפוליגוני של המסלול כולו. הקו הפוליגוני הזה הוא הקו הפוליגוני המשולב של כל |
description |
תיאור של המסלול. |
warnings[] |
מערך של אזהרות שיוצגו כשמציגים את המסלול. |
viewport |
התיבה התוחמת של אזור התצוגה של הקו המקוטע. |
travelAdvisory |
מידע נוסף על המסלול. |
optimizedIntermediateWaypointIndex[] |
אם מגדירים את |
localizedValues |
ייצוגים של מאפיינים של |
routeToken |
טוקן אטום שאפשר להעביר אל Navigation SDK כדי לשחזר את המסלול במהלך הניווט, ובמקרה של שינוי מסלול, לכבד את הכוונה המקורית כשנוצר המסלול. צריך להתייחס לטוקן הזה כאל blob אטום. אל תשוו את הערך שלו בין בקשות, כי הוא עשוי להשתנות גם אם השירות מחזיר את אותו מסלול בדיוק. הערה: |
polylineDetails |
מכיל מידע על פרטים לאורך הקו המרובה. |
RouteLabel
תוויות ל- שימושיות לזיהוי מאפיינים ספציפיים של המסלול לצורך השוואה למסלולים אחרים.Route
| טיפוסים בני מנייה (enum) | |
|---|---|
ROUTE_LABEL_UNSPECIFIED |
ברירת מחדל – לא בשימוש. |
DEFAULT_ROUTE |
מסלול ברירת המחדל 'הטוב ביותר' שמוחזר לחישוב המסלול. |
DEFAULT_ROUTE_ALTERNATE |
מסלול חלופי למסלול ברירת המחדל שהוא 'המסלול הטוב ביותר'. מסלולים כאלה יוחזרו כשמציינים את . |
FUEL_EFFICIENT |
מסלול חסכוני בדלק. מסלולים שמסומנים בערך הזה נחשבים למסלולים שעברו אופטימיזציה לפרמטרים של חיסכון, כמו צריכת דלק. |
SHORTER_DISTANCE |
מסלול עם מרחק נסיעה קצר יותר. זו תכונה ניסיונית. |
RouteLeg
מכיל קטע בין נקודות ציון שאינן via.
| ייצוג ב-JSON |
|---|
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object ( |
| שדות | |
|---|---|
distanceMeters |
מרחק הנסיעה של קטע המסלול, במטרים. |
duration |
משך הזמן שנדרש כדי לנווט בקטע המסלול. אם הערך של משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
staticDuration |
משך הנסיעה בקטע המסלול, שמחושב בלי להתחשב במצב התנועה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
polyline |
הקו הפוליגוני הכולל של הקטע הזה, שכולל את הקו הפוליגוני של כל |
startLocation |
מיקום ההתחלה של הקטע הזה. יכול להיות שהמיקום הזה יהיה שונה מהמיקום שצוין ב |
endLocation |
מיקום הסיום של הקטע הזה. יכול להיות שהמיקום הזה יהיה שונה מהמיקום שצוין ב |
steps[] |
מערך של שלבים שמציין פלחים בקטע המסלול הזה. כל שלב מייצג הוראת ניווט אחת. |
travelAdvisory |
מכיל את המידע הנוסף שהמשתמש צריך לקבל לגבי קטע מסוים במסלול, כמו הגבלות אפשריות באזור עם הגבלות תנועה. |
localizedValues |
ייצוגים של מאפיינים של |
stepsOverview |
מידע כללי על השלבים ב |
מצולע פתוח
מכיל קו פוליגוני מקודד.
| ייצוג ב-JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "encodedPolyline": string, "geoJsonLinestring": { object } // End of mutually exclusive fields. } |
| שדות | |
|---|---|
| מכיל את סוג הקו הפוליגוני. ברירת המחדל היא encoded_polyline. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
encodedPolyline |
מחרוזת הקידוד של הקו הפוליגוני באמצעות אלגוריתם קידוד הקו הפוליגוני |
geoJsonLinestring |
מגדיר קו פוליגוני באמצעות הפורמט GeoJSON LineString. |
| סוף השדות הבלעדיים. | |
RouteLegStep
מכיל פלח של . כל שלב מתאים להוראת ניווט אחת. קטעי המסלול מורכבים משלבים.RouteLeg
| ייצוג ב-JSON |
|---|
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object ( |
| שדות | |
|---|---|
distanceMeters |
מרחק הנסיעה בשלב הזה, במטרים. במקרים מסוימים, יכול להיות שלא יהיה ערך בשדה הזה. |
staticDuration |
משך הנסיעה בשלב הזה בלי להתחשב במצב התנועה. במקרים מסוימים, יכול להיות שלא יהיה ערך בשדה הזה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
polyline |
הקו הפוליגוני שמשויך לשלב הזה. |
startLocation |
מיקום ההתחלה של השלב הזה. |
endLocation |
מיקום הסיום של השלב הזה. |
navigationInstruction |
הוראות ניווט. |
travelAdvisory |
מכיל את המידע הנוסף שהמשתמש צריך לקבל לגבי שלב מסוים במסלול, כמו הגבלות אפשריות באזור תנועה. |
localizedValues |
ייצוגים של מאפיינים של |
transitDetails |
פרטים שקשורים לשלב הזה אם אמצעי התחבורה הוא |
travelMode |
אמצעי התחבורה שבו משתמשים בשלב הזה. |
תמרון
קבוצת ערכים שמציינים את פעולת הניווט שצריך לבצע בשלב הנוכחי (לדוגמה, פנייה שמאלה, השתלבות בתנועה או נסיעה ישר).
| טיפוסים בני מנייה (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 |
משמש לציון שינוי בשם רחוב. |
DESTINATION |
משמש לציון הגעה ליעד. |
RouteLegStepTravelAdvisory
מכיל את המידע הנוסף שהמשתמש צריך לקבל, כמו הגבלות אפשריות על אזורי תנועה בשלב מסוים בנסיעה.
| ייצוג ב-JSON |
|---|
{
"speedReadingIntervals": [
{
object ( |
| שדות | |
|---|---|
speedReadingIntervals[] |
הערה: השדה הזה לא מאוכלס כרגע. |
RouteLegStepLocalizedValues
ייצוגים של מאפיינים מסוימים בטקסט.
| ייצוג ב-JSON |
|---|
{ "distance": { object ( |
| שדות | |
|---|---|
distance |
מרחק הנסיעה מוצג בפורמט טקסט. |
staticDuration |
משך הזמן בלי להתחשב במצב התנועה, שמוצג בצורת טקסט. |
RouteLegStepTransitDetails
מידע נוסף על מסלולי TRANSIT שרלוונטי ל-RouteLegStep.
| ייצוג ב-JSON |
|---|
{ "stopDetails": { object ( |
| שדות | |
|---|---|
stopDetails |
מידע על תחנות ההגעה והיציאה של השלב. |
localizedValues |
ייצוגים של מאפיינים של |
headsign |
כיוון הנסיעה בקו הזה, כפי שמסומן ברכב או בתחנת המוצא. הכיוון הוא לרוב תחנת הקצה. |
headway |
מציין את הזמן הצפוי כמשך זמן בין יציאות מאותה תחנה בזמן הזה. לדוגמה, אם הערך של זמן ההמתנה בשניות הוא 600, אפשר לצפות להמתנה של עשר דקות אם מפספסים את האוטובוס. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
transitLine |
מידע על קו התחבורה הציבורית שבו משתמשים בשלב הזה. |
stopCount |
מספר העצירות מהתחנה שממנה יוצאים ועד לתחנת היעד. המספר הזה כולל את תחנת ההגעה, אבל לא את תחנת היציאה. לדוגמה, אם המסלול יוצא מתחנה א', עובר דרך תחנות ב' ו-ג' ומגיע לתחנה ד', הפונקציה |
tripShortText |
הטקסט שמופיע בלוחות זמנים ובשלטים כדי לזהות נסיעה בתחבורה ציבורית לנוסעים. הטקסט צריך לזהות באופן ייחודי נסיעה ביום שירות. לדוגמה, '538' הוא |
TransitStopDetails
פרטים על תחנות התחבורה הציבורית של RouteLegStep.
| ייצוג ב-JSON |
|---|
{ "arrivalStop": { object ( |
| שדות | |
|---|---|
arrivalStop |
מידע על תחנת ההגעה של השלב. |
arrivalTime |
זמן ההגעה המשוער לשלב. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
departureStop |
מידע על תחנת היציאה של השלב. |
departureTime |
שעת היציאה המשוערת של השלב. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
TransitStop
מידע על תחנת תחבורה ציבורית.
| ייצוג ב-JSON |
|---|
{
"name": string,
"location": {
object ( |
| שדות | |
|---|---|
name |
שם תחנת התחבורה הציבורית. |
location |
המיקום של התחנה בקואורדינטות של קו רוחב/אורך. |
TransitDetailsLocalizedValues
תיאורים מקומיים של ערכים עבור RouteTransitDetails.
| ייצוג ב-JSON |
|---|
{ "arrivalTime": { object ( |
| שדות | |
|---|---|
arrivalTime |
הזמן בייצוג טקסט מעוצב עם אזור זמן תואם. |
departureTime |
הזמן בייצוג טקסט מעוצב עם אזור זמן תואם. |
LocalizedTime
תיאור של הזמן שמותאם לשוק המקומי.
| ייצוג ב-JSON |
|---|
{
"time": {
object ( |
| שדות | |
|---|---|
time |
השעה שצוינה כמחרוזת באזור זמן מסוים. |
timeZone |
מכיל את אזור הזמן. הערך הוא שם אזור הזמן כפי שמוגדר במסד הנתונים של אזור הזמן בפורמט IANA, למשל America/New_York. |
TransitLine
מכיל מידע על קו התחבורה הציבורית שבו נעשה שימוש בשלב הזה.
| ייצוג ב-JSON |
|---|
{ "agencies": [ { object ( |
| שדות | |
|---|---|
agencies[] |
חברת התחבורה הציבורית (או חברות התחבורה הציבורית) שמפעילה את קו התחבורה הציבורית הזה. |
name |
השם המלא של קו התחבורה הזה, לדוגמה, '8 Avenue Local'. |
uri |
ה-URI של קו התחבורה הציבורית הזה, כפי שסופק על ידי חברת התחבורה הציבורית. |
color |
הצבע שמשמש בדרך כלל בשילוט של הקו הזה. הייצוג הוא הקסדצימלי. |
iconUri |
ה-URI של הסמל שמשויך לשורה הזו. |
nameShort |
השם הקצר של קו התחבורה הציבורית הזה. השם הזה יהיה בדרך כלל מספר קו, כמו M7 או 355. |
textColor |
הצבע שמשמש בדרך כלל לטקסט בשילוט של הקו הזה. הייצוג הוא הקסדצימלי. |
vehicle |
סוג כלי הרכב שפועל בקו התחבורה הציבורית הזה. |
TransitAgency
חברת תחבורה ציבורית שמפעילה קו תחבורה ציבורית.
| ייצוג ב-JSON |
|---|
{ "name": string, "phoneNumber": string, "uri": string } |
| שדות | |
|---|---|
name |
שם חברת התחבורה הציבורית. |
phoneNumber |
מספר הטלפון של רשות התחבורה הציבורית בפורמט שמותאם ללוקאל. |
uri |
ה-URI של חברת התחבורה הציבורית. |
TransitVehicle
מידע על כלי רכב שמשמשים במסלולי תחבורה ציבורית.
| ייצוג ב-JSON |
|---|
{ "name": { object ( |
| שדות | |
|---|---|
name |
השם של הרכב הזה, באותיות גדולות. |
type |
סוג הרכב שבו נעשה שימוש. |
iconUri |
ה-URI של סמל שמשויך לסוג כלי הרכב הזה. |
localIconUri |
מזהה ה-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[] |
מרווחי קריאה מהירה שמציינים את צפיפות התנועה. השדה הזה מאוכלס רק בבקשות שבהן הערך של דוגמה: |
RouteLegLocalizedValues
ייצוגים של מאפיינים מסוימים בטקסט.
| ייצוג ב-JSON |
|---|
{ "distance": { object ( |
| שדות | |
|---|---|
distance |
מרחק הנסיעה מוצג בפורמט טקסט. |
duration |
משך הזמן, שמוצג כטקסט ומתורגם לשפה המקומית של האזור שבו מתבצעת השאילתה. המסלול מתחשב במצב התנועה. הערה: אם לא ביקשתם מידע על תנועה, הערך הזה זהה לערך של staticDuration. |
staticDuration |
משך הזמן בלי להתחשב במצב התנועה, שמוצג בצורת טקסט. |
StepsOverview
מספק מידע כללי על רשימה של RouteLegStep.
| ייצוג ב-JSON |
|---|
{
"multiModalSegments": [
{
object ( |
| שדות | |
|---|---|
multiModalSegments[] |
סיכום מידע על פלחים שונים של |
MultiModalSegment
מספק מידע מסוכם על פלחי RouteLeg.steps שונים עם כמה אופנים. מקטע מולטי-מודאלי מוגדר כמקטע אחד או יותר של RouteLegStep סמוכים עם אותו RouteTravelMode. השדה הזה לא מאוכלס אם RouteLeg לא מכיל פלחים מרובי-ערוצים בשלבים.
| ייצוג ב-JSON |
|---|
{ "navigationInstruction": { object ( |
| שדות | |
|---|---|
navigationInstruction |
הוראות ניווט לפלח מולטימודאלי. |
travelMode |
אמצעי התחבורה של קטע הנסיעה המשלב כמה אמצעי תחבורה. |
stepStartIndex |
האינדקס התואם |
stepEndIndex |
האינדקס המתאים |
אזור התצוגה
אזור תצוגה של קווי רוחב ואורך, שמיוצג כשתי נקודות 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 ( |
| שדות | |
|---|---|
low |
חובה. הנקודה הנמוכה של אזור התצוגה. |
high |
חובה. הנקודה הגבוהה ביותר באזור התצוגה. |
RouteLocalizedValues
ייצוגים של מאפיינים מסוימים בטקסט.
| ייצוג ב-JSON |
|---|
{ "distance": { object ( |
| שדות | |
|---|---|
distance |
מרחק הנסיעה מוצג בפורמט טקסט. |
duration |
משך הזמן, שמוצג כטקסט ומתורגם לשפה המקומית של האזור שבו מתבצעת השאילתה. המסלול מתחשב במצב התנועה. הערה: אם לא ביקשתם מידע על תנועה, הערך הזה זהה לערך של |
staticDuration |
משך הזמן בלי להתחשב במצב התנועה, שמוצג בצורת טקסט. |
transitFare |
מחיר הנסיעה בתחבורה ציבורית, מוצג בפורמט טקסט. |
PolylineDetails
פרטים שמתאימים לאינדקס נתון או לפלח רציף של קו פוליגוני. בהינתן קו פוליגוני עם נקודות P_0, P_1, ... , P_N (אינדקס מבוסס-אפס), PolylineDetails מגדיר מרווח ומטא-נתונים משויכים.
| ייצוג ב-JSON |
|---|
{ "tunnelInfo": [ { object ( |
| שדות | |
|---|---|
tunnelInfo[] |
פרטי המנהרה לאורך הקו הפוליגוני. השדה הזה יאוכלס אם בבקשה מצוין משנה המסלול |
restrictionInfo[] |
פרטי ההגבלה לאורך הקו. השדה הזה מאוכלס רק אם בבקשה מצוין משנה המסלול |
flyoverInfo[] |
פרטים על המעוף מעל האזור לאורך הקו הפוליגוני. |
narrowRoadInfo[] |
פרטים על כביש צר לאורך הקו הפוליגוני. |
bridgeInfo[] |
פרטי הגשר לאורך הקו הפוליגוני. |
skywayInfo[] |
פרטי Skyway לאורך הקו הפוליגוני. |
TunnelInfo
האלמנט הזה מכיל מידע על מנהרות לאורך הקו הפוליגוני.
| ייצוג ב-JSON |
|---|
{ "tunnelPresence": enum ( |
| שדות | |
|---|---|
tunnelPresence |
מציין אם קיים מנהור עבור קטע נתון של הקו הפוליגוני. |
polylinePointIndex |
המיקום של מידע שקשור למנהרה לאורך הקו הפוליגוני. |
RoadFeatureState
האובייקט הזה מכיל את המצבים של מאפייני הכביש לאורך קו פוליגוני.
| טיפוסים בני מנייה (enum) | |
|---|---|
ROAD_FEATURE_STATE_UNSPECIFIED |
המצב של מאפיין הכביש לא חושב (ערך ברירת המחדל). |
EXISTS |
מאפיין הכביש קיים. |
DOES_NOT_EXIST |
תכונת הכביש לא קיימת. |
PolylinePointIndex
האובייקט הזה כולל את אינדקס ההתחלה ואינדקס הסיום של פרט בקו פוליגוני. במקרים שבהם הנתונים מתאימים לנקודה אחת, הערכים של startIndex ושל endIndex יהיו שווים.
| ייצוג ב-JSON |
|---|
{ "startIndex": integer, "endIndex": integer } |
| שדות | |
|---|---|
startIndex |
אינדקס ההתחלה של הפרט הזה בקו המעוקל. |
endIndex |
אינדקס הסיום של הפרט הזה בקו הפוליגוני. |
RestrictionInfo
האובייקט הזה מכיל מידע על מגבלות שונות לאורך הקו הפוליגוני.
| ייצוג ב-JSON |
|---|
{ "restrictionPresence": enum ( |
| שדות | |
|---|---|
restrictionPresence |
פלט בלבד. מציין אם קיימת הגבלה לקטע נתון של הקו הפוליגוני. |
polylinePointIndex |
המיקום של המידע שקשור להגבלה לאורך הקו המקוטע. |
| האובייקט הזה מכיל את סוגי ההגבלות שיכולות לחול על קטע נתון של קו פוליגוני. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות: | |
restrictedHeightMm |
מגבלת הגובה, במילימטרים. השדה הזה יאוכלס אם הגובה המוגבל מונע מעבר או גורם למרווח נמוך לרכב שצוין. |
restrictedWeightKg |
מגבלת המשקל בקילוגרמים. השדה הזה יאוכלס אם הגבלת המשקל מונעת מעבר או קרובה למשקל של הרכב שצוין. |
hazardousGoods |
השדה הזה מוגדר כ-true אם יש הגבלה על הובלת סחורות מסוכנות. |
trucksProhibited |
השדה הזה מוגדר כ-true כשהכניסה למשאיות אסורה. |
| סוף השדות הבלעדיים. | |
FlyoverInfo
כולל מידע על מעברים מעל קו הפוליגון.
| ייצוג ב-JSON |
|---|
{ "flyoverPresence": enum ( |
| שדות | |
|---|---|
flyoverPresence |
פלט בלבד. מציין אם יש מעבר מעל קטע מסוים של הקו הפוליגוני. |
polylinePointIndex |
המיקום של מידע שקשור לטיסה מעל קו הפוליגון. |
NarrowRoadInfo
האובייקט הזה מכיל מידע על כבישים צרים לאורך הקו הפוליגוני.
| ייצוג ב-JSON |
|---|
{ "narrowRoadPresence": enum ( |
| שדות | |
|---|---|
narrowRoadPresence |
פלט בלבד. מציין אם קיים כביש צר בקטע מסוים של הקו המקוקו. |
polylinePointIndex |
המיקום של מידע שקשור לכביש צר לאורך קו הפוליגון. |
BridgeInfo
האובייקט הזה מכיל מידע על גשרים לאורך הקו הפוליגוני.
| ייצוג ב-JSON |
|---|
{ "bridgePresence": enum ( |
| שדות | |
|---|---|
bridgePresence |
מציין אם יש גשר בקטע מסוים של הקו הפוליגוני. |
polylinePointIndex |
המיקום של מידע שקשור לגשר לאורך הקו הפוליגוני. |
SkywayInfo
האובייקט הזה מכיל מידע על גשרים עיליים לאורך הקו הפוליגוני.
| ייצוג ב-JSON |
|---|
{ "skywayPresence": enum ( |
| שדות | |
|---|---|
skywayPresence |
מציין אם יש גשר עילי בקטע מסוים של הקו הפוליגוני. |
polylinePointIndex |
המיקום של מידע שקשור לגשר עילי לאורך הקו הפוליגוני. |
GeocodingResults
מכיל לנקודת המוצא, ליעד ולנקודות הביניים. השדה הזה מאוכלס רק בנקודות ציון של כתובות.GeocodedWaypoints
| ייצוג ב-JSON |
|---|
{ "origin": { object ( |
| שדות | |
|---|---|
origin |
נקודת ציון גיאוגרפית של נקודת המוצא. |
destination |
נקודת ציון גיאוגרפית של היעד. |
intermediates[] |
רשימה של נקודות ציון ביניים שעברו גיאו-קידוד, שכל אחת מהן מכילה שדה אינדקס שתואם למיקום של נקודת הציון בסדר שבו היא צוינה בבקשה (הספירה מתחילה מאפס). |
GeocodedWaypoint
פרטים על המיקומים שמשמשים כנקודות ציון. השדה הזה מאוכלס רק בנקודות ציון של כתובות. כולל פרטים על תוצאות המרת כתובות לקואורדינטות (geocoding) לצורך קביעה של הכתובת שאליה בוצע הגיאו-קידוד.
| ייצוג ב-JSON |
|---|
{
"geocoderStatus": {
object ( |
| שדות | |
|---|---|
geocoderStatus |
קוד הסטטוס שמתקבל מפעולת הגיאו-קידוד. |
type[] |
סוג התוצאה, בצורה של תגי סוג אחד או יותר. סוגים נתמכים: סוגי כתובות וסוגי רכיבי כתובות. |
partialMatch |
מציין שכלי להמרת כתובות לקואורדינטות (geocoder) לא החזיר התאמה מדויקת לבקשה המקורית, אבל הוא הצליח להתאים חלק מכתובת הבקשה. כדאי לבדוק את הבקשה המקורית ולחפש שגיאות כתיב או כתובת לא מלאה. |
placeId |
מזהה המקום של התוצאה הזו. |
intermediateWaypointRequestIndex |
האינדקס של נקודת הביניים המתאימה בבקשה. השדה הזה מאוכלס רק אם נקודת הדרך התואמת היא נקודת דרך ביניים. |