- בקשת HTTP
- גוף הבקשה
- גוף התגובה
- PolylineQuality
- PolylineEncoding
- ReferenceRoute
- ExtraComputation
- מסלול
- RouteLabel
- RouteLeg
- קו פוליגוני
- RouteLegStep
- NavigationInstruction
- תמרון
- RouteLegStepTravelAdvisory
- RouteLegStepLocalizedValues
- RouteLegStepTransitDetails
- TransitStopDetails
- TransitStop
- TransitDetailsLocalizedValues
- LocalizedTime
- TransitLine
- TransitAgency
- TransitVehicle
- TransitVehicleType
- RouteLegTravelAdvisory
- RouteLegLocalizedValues
- StepsOverview
- MultiModalSegment
- אזור התצוגה
- 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 (דומיין ברמה העליונה) באורך שני תווים. מידע נוסף זמין במאמר דומיינים ברמה העליונה עם קוד מדינה (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 |
מציין קו פוליגוני באמצעות פורמט LineString של GeoJSON |
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. הנתונים האלה יאוכלסו כרגע רק באזורי מטרופולין מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות. |
NARROW_ROAD_INFO_ON_POLYLINE |
מידע על כבישים צרים במסלולים. כדי לקבל את המידע הזה, צריך לציין את מסכת השדות routes.polyline_details.narrow_road_info. הנתונים האלה יאוכלסו כרגע רק באזורי מטרופולין מסוימים בהודו. התכונה הזו ניסיונית, והמק"ט או החיוב עשויים להשתנות. |
TUNNEL_INFO_ON_POLYLINE |
מידע על מנהרות במסלולים. כדי לקבל את המידע הזה, צריך לציין את מסכת השדות routes.polyline_details.tunnel_info. |
BRIDGE_INFO_ON_POLYLINE |
מידע על גשרים במסלולים. כדי לקבל את המידע הזה, צריך לציין את מסכת השדות routes.polyline_details.bridge_info. |
SKYWAY_INFO_ON_POLYLINE |
מידע על גשרים להולכי רגל במסלולים. כדי לקבל את המידע הזה, צריך לציין את מסכת השדות routes.polyline_details.skyway_info. |
נתיב
מכיל מסלול שמורכב מסדרה של מקטעי כביש מחוברים שמחברים בין נקודות ציון של התחלה, סיום ונקודות ביניים.
| ייצוג ב-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 |
מציין קו פוליגוני באמצעות פורמט LineString של GeoJSON. |
| סוף השדות שמוציאים זה את זה. | |
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
מידע נוסף על RouteLegStep שקשור למסלולים של TRANSIT.
| ייצוג ב-JSON |
|---|
{ "stopDetails": { object ( |
| שדות | |
|---|---|
stopDetails |
מידע על תחנות ההגעה והיציאה של השלב. |
localizedValues |
ייצוגים בטקסט של מאפייני |
headsign |
מציין את כיוון הנסיעה בקו הזה, כפי שהוא מסומן על הרכב או בתחנת היציאה. הכיוון הוא בדרך כלל התחנה הסופית. |
headway |
מציין את הזמן הצפוי כמשך הזמן בין היציאות מאותה תחנה בזמן הזה. לדוגמה, אם הערך של מרווח הזמן בשניות הוא 600, זמן ההמתנה הצפוי אם פספסתם את האוטובוס הוא 10 דקות. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-" |
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 |
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[] |
פרטי הגשר המקורה לאורך הקו הפוליגוני. |
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[] |
רשימה של נקודות ציון ביניים שהומרו לקואורדינטות, שכל אחת מהן מכילה שדה אינדקס שתואם למיקום של נקודת הציון בסדר שבו הן צוינו בבקשה, החל מ-0. |
GeocodedWaypoint
פרטים על המיקומים שמשמשים כנקודות ציון. מאוכלס רק בנקודות ציון של כתובות. כולל פרטים על תוצאות המרת הכתובות לקואורדינטות, כדי לקבוע לאיזה מיקום הכתובת הומרה.
| ייצוג ב-JSON |
|---|
{
"geocoderStatus": {
object ( |
| שדות | |
|---|---|
geocoderStatus |
מציין את קוד הסטטוס שנוצר כתוצאה מהפעולה של המרת הכתובת לקואורדינטות. |
type[] |
סוגי התוצאות, בצורה של אפס או יותר תגי סוג. סוגים נתמכים: סוגי כתובות וסוגי רכיבים של כתובות. |
partialMatch |
מציין שהכלי להמרת כתובות לקואורדינטות לא החזיר התאמה מדויקת לבקשה המקורית, אבל הצליח להתאים חלק מהכתובת המבוקשת. כדאי לבדוק אם יש שגיאות כתיב או כתובת לא מלאה בבקשה המקורית. |
placeId |
מזהה המקום של התוצאה הזו. |
intermediateWaypointRequestIndex |
האינדקס של נקודת הביניים המתאימה בבקשה. השדה הזה מאוכלס רק אם נקודת הדרך התואמת היא נקודת דרך ביניים. |