Directions

הכיתה DirectionsService

google.maps.DirectionsService class

שירות לחישוב מסלולים בין שני מקומות או יותר.

אפשר לגשת אליו באמצעות חיוג למספר const {DirectionsService} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

DirectionsService
DirectionsService()
פרמטרים:  ללא
יצירת מכונה חדשה של DirectionsService ששולחת שאילתות לקבלת מסלול לשרתים של Google.
route
route(request[, callback])
פרמטרים: 
ערך המוחזר:  Promise<DirectionsResult>
שולחים בקשה לחיפוש מסלול.

הממשק DirectionsRequest

ממשק google.maps.DirectionsRequest

שאילתה לגבי מסלול שתשלח אל DirectionsService.

destination
סוג:  string|LatLng|Place|LatLngLiteral
המיקום של היעד. אפשר לציין את הערך כמחרוזת שצריך לבצע לה גיאוקוד, כ-LatLng או כ-Place. חובה.
origin
סוג:  string|LatLng|Place|LatLngLiteral
מיקום המקור. אפשר לציין את הערך כמחרוזת שצריך לבצע לה גיאוקוד, כ-LatLng או כ-Place. חובה.
travelMode
סוג:  TravelMode
סוג הניתוב המבוקש. חובה.
avoidFerries optional
סוג:  boolean optional
אם הערך הוא true, המערכת תורה לשירות המסלול להימנע ממעבורות ככל האפשר. זה שינוי אופציונלי.
avoidHighways optional
סוג:  boolean optional
אם הערך הוא true, המערכת תורה לשירות המסלול להימנע מכבישים מהירים במידת האפשר. זה שינוי אופציונלי.
avoidTolls optional
סוג:  boolean optional
אם הערך הוא true, המערכת תורה לשירות הניווט להימנע מכבישי אגרה במידת האפשר. זה שינוי אופציונלי.
drivingOptions optional
סוג:  DrivingOptions optional
הגדרות שחלות רק על בקשות שבהן הערך של travelMode הוא DRIVING. לא תהיה לאובייקט הזה השפעה על שיטות נסיעה אחרות.
language optional
סוג:  string optional
מזהה שפה של השפה שבה צריך להציג את התוצאות, כשהדבר אפשרי. כאן אפשר לעיין ברשימת השפות הנתמכות.
optimizeWaypoints optional
סוג:  boolean optional
אם הערך מוגדר כ-true, ה-DirectionsService ינסה לסדר מחדש את נקודות הדרך הביניים שסופקו כדי למזער את העלות הכוללת של המסלול. אם נערכה אופטימיזציה לנקודות העצירה, צריך לבדוק את השדה DirectionsRoute.waypoint_order בתגובה כדי לקבוע את הסדר החדש.
provideRouteAlternatives optional
סוג:  boolean optional
האם צריך לספק מסלולים חלופיים. זה שינוי אופציונלי.
region optional
סוג:  string optional
קוד האזור שמשמש כנטייה לטובת בקשות לגיאוקודציה. קוד האזור יכול להכיל ערך בן שני תווים של דומיין ברמה עליונה עם קוד מדינה (ccTLD). רוב הקודים של הדומיינים ברמה הלאומית זהים לקודי ISO 3166-1, מלבד כמה יוצאים מן הכלל. לדוגמה, הדומיין ברמה העליונה של בריטניה הוא 'uk' (.co.uk), ואילו הקוד שלה ב-ISO 3166-1 הוא 'gb' (טכנית, עבור הישות 'ממלכת בריטניה הגדולה וצפון אירלנד').
transitOptions optional
סוג:  TransitOptions optional
הגדרות שחלות רק על בקשות שבהן הערך של travelMode הוא TRANSIT. לא תהיה לאובייקט הזה השפעה על שיטות נסיעה אחרות.
unitSystem optional
סוג:  UnitSystem optional
ברירת מחדל: מערכת היחידות שבה נעשה שימוש במדינה המקור.
מערכת היחידות המועדפת לשימוש כשמציגים מרחק.
waypoints optional
סוג:  Array<DirectionsWaypoint> optional
מערך של נקודות דרך ביניים. המסלול מחושב מנקודת המוצא ליעד דרך כל נקודת ציון במערך הזה. במדריך למפתחים מפורט המספר המקסימלי של נקודות ציון שמותר להוסיף. אין תמיכה בציוני דרך במסלולי תחבורה ציבורית. זה שינוי אופציונלי.

קבועים של DirectionsStatus

google.maps.DirectionsStatus קבועים

הסטטוס שהוחזר על ידי DirectionsService בסיום קריאה ל-route(). אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'OK' או google.maps.DirectionsStatus.OK.

אפשר לגשת אליו באמצעות חיוג למספר const {DirectionsStatus} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

INVALID_REQUEST הערך של DirectionsRequest שסופק לא תקף.
MAX_WAYPOINTS_EXCEEDED צוינו יותר מדי DirectionsWaypoint ב-DirectionsRequest. במדריך למפתחים מפורט המספר המקסימלי של נקודות ציון שמותר להוסיף.
NOT_FOUND לא ניתן היה לבצע גיאוקוד לפחות לאחד מהמקור, היעד או נקודות העצירה.
OK התשובה מכילה DirectionsResult תקין.
OVER_QUERY_LIMIT דף האינטרנט חרג ממגבלת הבקשות בפרק זמן קצר מדי.
REQUEST_DENIED לאתר האינטרנט אסור להשתמש בשירות המסלול.
UNKNOWN_ERROR לא ניתן היה לעבד בקשה לקבלת מסלול בגלל שגיאה בשרת. יכול להיות שהבקשה תצליח אם תנסה שוב.
ZERO_RESULTS לא נמצא מסלול בין נקודת היציאה ליעד.

הממשק DirectionsResult

ממשק google.maps.DirectionsResult

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

request
הבקשה לקבלת מסלול שבעקבותיה התקבלה התוצאה הזו.
routes
מערך של רכיבי DirectionsRoute, שכל אחד מהם מכיל מידע על הרגליים והשלבים שמהם הוא מורכב. יהיה רק מסלול אחד, אלא אם ה-DirectionsRequest נוצר עם provideRouteAlternatives שמוגדר כ-true.
available_travel_modes optional
סוג:  Array<TravelMode> optional
מכיל מגוון של אמצעי הגעה זמינים. השדה הזה מוחזר כשבקשה מציינת דרך נסיעה ולא מקבלת תוצאות. המערך מכיל את אמצעי התחבורה הזמינים במדינות של קבוצת נקודות הדרך הנתונה. השדה הזה לא מוחזר אם אחת או יותר מנקודות הדרך מוגדרות כ 'דרך נקודות דרך'.
geocoded_waypoints optional
סוג:  Array<DirectionsGeocodedWaypoint> optional
מערך של רכיבי DirectionsGeocodedWaypoint, שכל אחד מהם מכיל מידע על הגיאוקוד של המוצא, היעד ונקודות העצירה.

הכיתה DirectionsRenderer

google.maps.DirectionsRenderer class

המערכת תיצור גרפיקה של מסלולים שהתקבלו מ-DirectionsService.

הכיתה הזו היא תת-מחלקה של MVCObject.

אפשר לגשת אליו באמצעות חיוג למספר const {DirectionsRenderer} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

DirectionsRenderer
DirectionsRenderer([opts])
פרמטרים: 
יצירת המכשיר להמרת גרפיקה באמצעות האפשרויות שצוינו. אפשר להציג מסלולים במפה (כשכבות-על חזותיות) או בנוסף בחלונית <div> (כהוראות טקסט).
getDirections
getDirections()
פרמטרים:  ללא
ערך המוחזר:  DirectionsResult
הפונקציה מחזירה את קבוצת ההוראות הנוכחית של ה-Renderer.
getMap
getMap()
פרמטרים:  ללא
ערך המוחזר:  Map
הפונקציה מחזירה את המפה שבה מתבצע הרינדור של DirectionsResult.
getPanel
getPanel()
פרמטרים:  ללא
ערך המוחזר:  HTMLElement|null
הפונקציה מחזירה את החלונית <div> שבה ה-DirectionsResult עבר עיבוד.
getRouteIndex
getRouteIndex()
פרמטרים:  ללא
ערך המוחזר:  number
הפונקציה מחזירה את אינדקס המסלול הנוכחי (שמתחיל בספרה אפס) שנמצא בשימוש באובייקט DirectionsRenderer הזה.
setDirections
setDirections(directions)
פרמטרים: 
ערך המוחזר:  None
מגדירים את ה-renderer כך שישתמש בתוצאה מ-DirectionsService. הגדרה של קבוצת מסלולים תקינה באופן הזה תציג את המסלולים במפה ובחלונית הייעודיים של ה-Renderer.
setMap
setMap(map)
פרמטרים: 
ערך המוחזר:  None
השיטה הזו מציינת את המפה שבה יוצגו המסלולים. עוברים על null כדי להסיר את המסלול מהמפה.
setOptions
setOptions(options)
פרמטרים: 
ערך המוחזר:  None
משנים את הגדרות האפשרויות של DirectionsRenderer הזה אחרי האיפוס.
setPanel
setPanel(panel)
פרמטרים: 
ערך המוחזר:  None
השיטה הזו מייצרת את המסלול ב-<div>. מעבירים את null כדי להסיר את התוכן מהחלונית.
setRouteIndex
setRouteIndex(routeIndex)
פרמטרים: 
  • routeIndexnumber
ערך המוחזר:  None
מגדירים את האינדקס (שמתחיל באפס) של המסלול באובייקט DirectionsResult לצורך רינדור. כברירת מחדל, המסלול הראשון במערך יעובד.
עובר בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
directions_changed
function()
ארגומנטים:  None
האירוע הזה מופעל כשהמסלול שעבר עיבוד משתנה, בין אם מוגדר DirectionsResult חדש ובין אם המשתמש מסיים לגרור שינוי לנתיב המסלול.

הממשק DirectionsRendererOptions

ממשק google.maps.DirectionsRendererOptions

האובייקט הזה מגדיר את המאפיינים שאפשר להגדיר באובייקט DirectionsRenderer.

directions optional
סוג:  DirectionsResult optional
המסלול שמוצג במפה ו/או בחלונית <div>, שמאוחזר כאובייקט DirectionsResult מ-DirectionsService.
draggable optional
סוג:  boolean optional
אם הערך הוא true, המשתמש יכול לגרור ולשנות את הנתיבים של המסלולים ש-DirectionsRenderer הזה יוצר.
hideRouteList optional
סוג:  boolean optional
ברירת מחדל: false
המאפיין הזה מציין אם ה-Renderer צריך לספק רשימה של מסלולים שמוצגים בחלונית המסלול, והמשתמשים יכולים לבחור מתוכה.
infoWindow optional
סוג:  InfoWindow optional
InfoWindow שבו ייוצגו פרטי הטקסט כשמקישים על סמן. התוכן הקיים בחלון המידע יוחלף והמיקום שלו יועבר. אם לא צוין חלון מידע, ה-DirectionsRenderer ייצור חלון מידע משלו וישתמש בו. המערכת תתעלם מהמאפיין הזה אם suppressInfoWindows מוגדר כ-true.
map optional
סוג:  Map optional
המפה שבה יוצגו המסלולים.
markerOptions optional
סוג:  MarkerOptions optional
אפשרויות לסימונים. כל הסמנים שיוצגו על ידי DirectionsRenderer ישתמשו באפשרויות האלה.
panel optional
סוג:  HTMLElement optional
<div> שבו יוצגו שלבי ההוראות.
polylineOptions optional
סוג:  PolylineOptions optional
אפשרויות לקווים פוליגונליים. כל הקווים הפוליגונליים שיוצגו על ידי DirectionsRenderer ישתמשו באפשרויות האלה.
preserveViewport optional
סוג:  boolean optional
ברירת מחדל: false
אם האפשרות הזו מוגדרת כ-true או שמעולם לא הגדרתם את מרכז המפה ואת רמת הזום שלה, מרכז המפה של הקלט יתמקם בקופסה המקיפה של קבוצת ההוראות הזו, ורמת הזום תהיה תואמת לקופסה הזו.
routeIndex optional
סוג:  number optional
האינדקס של המסלול בתוך האובייקט DirectionsResult. ערך ברירת המחדל הוא 0.
suppressBicyclingLayer optional
סוג:  boolean optional
להפסיק את העיבוד של BicyclingLayer כשמבקשים מסלול רכיבה על אופניים.
suppressInfoWindows optional
סוג:  boolean optional
מניעת העיבוד של חלונות המידע.
suppressMarkers optional
סוג:  boolean optional
מניעת העיבוד של סמנים.
suppressPolylines optional
סוג:  boolean optional
ביטול העיבוד של קווים פוליגונים.

ממשק DirectionsWaypoint

ממשק google.maps.DirectionsWaypoint

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

location optional
סוג:  string|LatLng|LatLngLiteral|Place optional
מיקום של ציון דרך. יכול להיות מחרוזת כתובת, LatLng או Place. זה שינוי אופציונלי.
stopover optional
סוג:  boolean optional
ברירת מחדל: true
אם הערך הוא true, המשמעות היא שנקודת הציון הזו היא עצירה בין נקודת היציאה ליעד. כתוצאה מכך, המסלול מפוצל לשני חלקים. אם הערך הוא false, המערכת תנסה להעביר את המסלול דרך נקודת הציון הזו, אבל לא לפצל אותו לשני חלקים. האפשרות הזו שימושית אם רוצים ליצור מסלול בתגובה לגרירת נקודות ציון על המפה על ידי המשתמש.

הממשק DirectionsGeocodedWaypoint

ממשק google.maps.DirectionsGeocodedWaypoint

נקודת ציון אחת עם קואורדינטות גיאוגרפיות.

partial_match optional
סוג:  boolean optional
אם מקודד המיקום לא החזיר התאמה מדויקת לנקודת הדרך המקורית, אבל הצליח להתאים חלק מהכתובת המבוקשת.
place_id optional
סוג:  string optional
מזהה המקום שמשויך לנקודת הציון. המזהה הייחודי של מקום במסד הנתונים של 'מקומות Google' ובמפות Google. מידע נוסף על מזהי מקומות זמין במדריך למפתחים של Places API.
types optional
סוג:  Array<string> optional
מערך של מחרוזות שמציין את הסוג של הרכיב המאומת שהוחזר. רשימה של מחרוזות אפשריות מופיעה בקטע סוגי רכיבי כתובת במדריך למפתחים.

הממשק DirectionsRoute

ממשק google.maps.DirectionsRoute

מסלול יחיד שמכיל קבוצה של קטעים ב-DirectionsResult. שימו לב: למרות שהאובייקט הזה דומה ל-JSON, הוא לא JSON לחלוטין, כי הוא כולל אובייקטים מסוג LatLng באופן ישיר ועקיף.

bounds
סוג:  LatLngBounds
הגבולות של המסלול הזה.
copyrights
סוג:  string
טקסט של זכויות יוצרים שיוצג במסלול הזה.
legs
סוג:  Array<DirectionsLeg>
מערך של רכיבי DirectionsLeg, שכל אחד מהם מכיל מידע על השלבים שהוא מורכב מהם. תהיה שלב אחד לכל יעד או נקודת ציון עצירה שצוינו. לכן, מסלול ללא נקודות עצירה ביניים יכלול DirectionsLeg אחת, ומסלול עם נקודת עצירה ביניים אחת יכלול שתיים.
overview_path
סוג:  Array<LatLng>
מערך של LatLng שמייצג את כל המסלול של המסלול הזה. הנתיב פשוט יותר כדי שיהיה מתאים להקשרים שבהם נדרש מספר קטן של קודקודים (כמו כתובות URL של Static Maps API).
overview_polyline
סוג:  string
ייצוג של קו פוליגוני מקודד של המסלול בקטע overview_path. הקו הפוליגוני הזה הוא נתיב משוער (חלק) של המסלול שנוצר.
summary
סוג:  string
מכיל תיאור טקסטואלי קצר של המסלול, שמתאים למתן שם למסלול ולפירוט ההבדלים בינו לבין מסלולים חלופיים.
warnings
סוג:  Array<string>
אזהרות שיוצגו כשהמסלול הזה יוצג.
waypoint_order
סוג:  Array<number>
אם הערך של optimizeWaypoints מוגדר כ-true, השדה הזה יכיל את המחרוזת הממוזגת של נקודות הדרך שהוזנו. לדוגמה, אם הקלט היה:
  Origin: Los Angeles
  Waypoints: Dallas, Bangor, Phoenix
  Destination: New York
והפלט המותאם אופטימלית הוגדר בסדר הבא:
  Origin: Los Angeles
  Waypoints: Phoenix, Dallas, Bangor
  Destination: New York
השדה הזה יהיה Array שמכיל את הערכים [2, 0, 1]. שימו לב: מספרי נקודות הדרך מתחילים באפס.
אם באחד מנקודות הציון להזנה הערך של stopover מוגדר כ-false, השדה הזה יהיה ריק כי אופטימיזציה של מסלולים לא זמינה לשאילתות כאלה.
fare optional
סוג:  TransitFare optional
המחיר הכולל של כל הנסיעה בתחבורה הציבורית. רלוונטי רק לבקשות לתחבורה ציבורית.

הממשק DirectionsLeg

ממשק google.maps.DirectionsLeg

רגל אחת שמכילה קבוצה של שלבים ב-DirectionsResult. יכול להיות שחלק מהשדות בחלק לא יחזרו בכל הבקשות. שימו לב: התוצאה הזו 'דומה ל-JSON', אבל היא לא JSON לחלוטין, כי היא כוללת אובייקטים מסוג LatLng באופן ישיר ועקיף.

end_address
סוג:  string
הכתובת של היעד של הקטע הזה. התוכן הזה נועד לקריאה כפי שהוא. אין לנתח את הכתובת בפורמט באופן פרוגרמטי.
end_location
סוג:  LatLng
ה-DirectionsService מחשב מסלולים בין מיקומים על סמך אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) במיקומי ההתחלה והסיום. השדה end_location מציין את היעד בפועל שעבר גיאוקוד. הוא עשוי להיות שונה מהשדה end_location בשלב האחרון, אם למשל הכביש לא נמצא ליד היעד של הקטע הזה.
start_address
סוג:  string
הכתובת של המקור של הקטע הזה. התוכן הזה נועד לקריאה כפי שהוא. אין לנתח את הכתובת בפורמט באופן פרוגרמטי.
start_location
סוג:  LatLng
ה-DirectionsService מחשב מסלולים בין מיקומים על סמך אפשרות התחבורה הקרובה ביותר (בדרך כלל כביש) במיקומי ההתחלה והסיום. start_location מציין את המקור בפועל שעבר גיאוקוד, שעשוי להיות שונה מ-start_location של השלב הראשון אם, לדוגמה, הכביש לא נמצא ליד המקור של הקטע הזה.
steps
מערך של רכיבי DirectionsStep, שכל אחד מהם מכיל מידע על השלבים הנפרדים בשלב הזה.
traffic_speed_entry
סוג:  Array<?>
מידע על מהירות התנועה לאורך הקטע.
via_waypoints
סוג:  Array<LatLng>
מערך של נקודות ציון לאורך המסלול הזה, שאינן תחנות מעבר, שצוינו בבקשה המקורית.

התכונה הוצאה משימוש במסלולים חלופיים. גרסה 3.27 תהיה הגרסה האחרונה של ה-API שמוסיפה via_waypoints נוסף בנתיבים חלופיים.

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

arrival_time optional
סוג:  Time optional
שעת ההגעה המשוערת של הקטע הזה. רלוונטי רק לבקשות מסוג TRANSIT.
departure_time optional
סוג:  Time optional
שעת המראה המשוערת של הקטע הזה. רלוונטי רק לבקשות מסוג TRANSIT.
distance optional
סוג:  Distance optional
המרחק הכולל שעברתם בשלב הזה. יכול להיות שהמאפיין הזה לא יוגדר כי המרחק עשוי להיות לא ידוע.
duration optional
סוג:  Duration optional
משך הזמן הכולל של הקטע הזה. המאפיין הזה יכול להיות undefined כי משך הזמן עשוי להיות לא ידוע.
duration_in_traffic optional
סוג:  Duration optional
משך הזמן הכולל של הקטע הזה, תוך התחשבות בתנאי התנועה שצוינו במאפיין trafficModel. המאפיין הזה יכול להיות undefined כי משך הזמן עשוי להיות לא ידוע.

הממשק DirectionsStep

ממשק google.maps.DirectionsStep

DirectionsStep יחיד ב-DirectionsResult. יכול להיות שחלק מהשדות יהיו undefined. שימו לב: האובייקט הזה דומה ל-JSON, אבל הוא לא JSON לחלוטין כי הוא כולל ישירות אובייקטים מסוג LatLng.

encoded_lat_lngs
סוג:  string
ייצוג של קו מרובה (polyline) עם קידוד של השלב. זהו מסלול משוער (חלק) של השלב.
end_location
סוג:  LatLng
המיקום הסופי של השלב הזה.
end_point
סוג:  LatLng
המיקום הסופי של השלב הזה.
instructions
סוג:  string
הוראות לשלב הזה.
lat_lngs
סוג:  Array<LatLng>
רצף של LatLng שמתארים את מהלך השלב הזה. זהו מסלול משוער (חלק) של השלב.
maneuver
סוג:  string
מכיל את הפעולה שצריך לבצע בשלב הנוכחי (turn-left,‏ merge,‏ straight וכו'). הערכים עשויים להשתנות, וייתכן שיתווספו ערכים חדשים ללא הודעה מוקדמת.
path
סוג:  Array<LatLng>
רצף של LatLng שמתארים את מהלך השלב הזה. זהו מסלול משוער (חלק) של השלב.
start_location
סוג:  LatLng
מיקום ההתחלה של השלב הזה.
start_point
סוג:  LatLng
מיקום ההתחלה של השלב הזה.
travel_mode
סוג:  TravelMode
אופן הנסיעה בשלב הזה.
distance optional
סוג:  Distance optional
המרחק שעברתם בשלב הזה. המאפיין הזה יכול להיות undefined כי המרחק עשוי להיות לא ידוע.
duration optional
סוג:  Duration optional
הזמן הממוצע הנדרש לביצוע השלב הזה, בשניות ובטקסט. המאפיין הזה יכול להיות undefined כי משך הזמן עשוי להיות לא ידוע.
polyline optional
סוג:  DirectionsPolyline optional
מכיל אובייקט עם נכס יחיד, 'points', שמכיל ייצוג של השלב כקו פוליגון מקודד. קו הפוליגון הזה הוא נתיב משוער (חלק) של השלב.
steps optional
סוג:  Array<DirectionsStep> optional
שלבים משניים של השלב הזה. מצוין בקטעים של מסלולי תחבורה ציבורית שלא מיועדים לתחבורה ציבורית.
transit optional
סוג:  TransitDetails optional
פרטים ספציפיים לתחבורה הציבורית לגבי השלב הזה. המאפיין הזה לא יוגדר אלא אם אופן התחבורה של השלב הזה הוא TRANSIT.
transit_details optional
סוג:  TransitDetails optional
פרטים לגבי השלב הזה אם אופן הנסיעה הוא TRANSIT.

הממשק DirectionsPolyline

ממשק google.maps.DirectionsPolyline

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

points
סוג:  string

ממשק Place

ממשק google.maps.Place

מכיל מידע שנחוץ כדי לאתר, לזהות או לתאר מקום של DirectionsRequest או DistanceMatrixRequest. בהקשר הזה, 'מקום' הוא עסק, מקום מעניין או מיקום גיאוגרפי. למידע נוסף על אחזור מידע על מקום מסוים, אפשר לעיין במאמר PlacesService.

location optional
סוג:  LatLng|LatLngLiteral optional
ה-LatLng של הישות שמתוארת על ידי המקום הזה.
placeId optional
סוג:  string optional
מזהה המקום של המקום (למשל עסק או נקודת עניין). מזהה המקום הוא מזהה ייחודי של מקום במסד הנתונים של מפות Google. חשוב לזכור ש-placeId היא הדרך המדויקת ביותר לזהות מקום. אם אפשר, כדאי לציין את placeId במקום query. אפשר לאחזר מזהה מקום מכל בקשה ל-Places API, למשל TextSearch. אפשר לאחזר מזהי מקומות גם מבקשות ל-Geocoding API. מידע נוסף זמין בסקירה הכללית על מזהי מקומות.
query optional
סוג:  string optional
שאילתה לחיפוש שמתארת את המקום (למשל עסק או נקודת עניין). דוגמה לשאילתה: "Quay, Upper Level, Overseas Passenger Terminal 5 Hickson Road, The Rocks NSW". אם אפשר, כדאי לציין את placeId במקום query. ה-API לא מבטיח את הדיוק של פתרון מחרוזת השאילתה למקום. אם מציינים גם את placeId וגם את query, מתרחשת שגיאה.

קבועים של TravelMode

google.maps.TravelMode קבועים

אמצעי ההגעה התקפים שאפשר לציין ב-DirectionsRequest, וגם אמצעי ההגעה שמוחזרים ב-DirectionsStep. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'BICYCLING' או google.maps.TravelMode.BICYCLING.

אפשר לגשת אליו באמצעות חיוג למספר const {TravelMode} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

BICYCLING מציין בקשה למסלול רכיבה על אופניים.
DRIVING מציין בקשה למסלול נסיעה.
TRANSIT מציין בקשה למסלול לתחבורה ציבורית.
WALKING מציין בקשה למסלול הליכה.

הממשק של DrivingOptions

ממשק google.maps.DrivingOptions

הגדרת DirectionsRequest כשמצב הנסיעה מוגדר ל-DRIVING.

departureTime
סוג:  Date
שעת היציאה הרצויה במסלול, שצוינה כאובייקט Date. האובייקט Date מודד את הזמן באלפיות השנייה מאז 1 בינואר 1970. צריך לציין את הערך הזה כדי ש-DrivingOptions יהיה תקף. שעת היציאה צריכה להיות השעה הנוכחית או שעה כלשהי בעתיד. הוא לא יכול להיות בעבר.
trafficModel optional
סוג:  TrafficModel optional
ההנחה המועדפת לשימוש בתחזית משך הזמן בתנועה. ערך ברירת המחדל הוא BEST_GUESS.

קבועים של TrafficModel

google.maps.TrafficModel קבועים

ההנחות שיש להשתמש בהן כשמחזיעים את משך הזמן בתנועה. מצוין כחלק מ-DirectionsRequest או מ-DistanceMatrixRequest. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'bestguess' או google.maps.TrafficModel.BEST_GUESS.

אפשר לגשת אליו באמצעות חיוג למספר const {TrafficModel} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

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

הממשק TransitOptions

ממשק google.maps.TransitOptions

אובייקט TransitOptions שצריך לכלול ב-DirectionsRequest כשמצב הנסיעה מוגדר ל-TRANSIT.

arrivalTime optional
סוג:  Date optional
שעת ההגעה הרצויה למסלול, שצוינה כאובייקט Date. אובייקט Date מודד את הזמן באלפיות שנייה מאז 1 בינואר 1970. אם צוינה שעת הגעה, המערכת מתעלמת משעת היציאה.
departureTime optional
סוג:  Date optional
שעת היציאה הרצויה במסלול, שצוינה כאובייקט Date. אובייקט Date מודד את הזמן באלפיות שנייה מאז 1 בינואר 1970. אם לא צוין זמן יציאה או זמן הגעה, המערכת מניחה שהשעה היא 'עכשיו'.
modes optional
סוג:  Array<TransitMode> optional
אמצעי תחבורה ציבורית מועדף אחד או יותר, כמו אוטובוס או רכבת. אם לא צוינה העדפה, ה-API מחזיר את המסלול הטוב ביותר שמוגדר כברירת מחדל.
routingPreference optional
סוג:  TransitRoutePreference optional
העדפה שיכולה להשפיע על בחירת מסלול התחבורה הציבורית, למשל פחות הליכה. אם לא צוינה העדפה, ה-API מחזיר את המסלול הטוב ביותר שמוגדר כברירת מחדל.

קבועים של TransitMode

google.maps.TransitMode קבועים

אמצעי התחבורה הציבורית החוקי, למשל אוטובוס, שאפשר לציין ב-TransitOptions. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'BUS' או google.maps.TransitMode.BUS.

אפשר לגשת אליו באמצעות חיוג למספר const {TransitMode} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

BUS מציין אוטובוס כאמצעי התחבורה המועדף.
RAIL מציין את הרכבת כאמצעי התחבורה המועדף.
SUBWAY מציין את הרכבת התחתית כאמצעי התחבורה המועדף.
TRAIN מציין את הרכבת כאמצעי התחבורה המועדף.
TRAM מציין את החשמלית כאמצעי התחבורה המועדף.

קבועים של TransitRoutePreference

google.maps.TransitRoutePreference קבועים

סוג המסלול בתחבורה הציבורית שאפשר לציין ב-TransitOptions. אפשר לציין אותם לפי ערך או באמצעות שם הקבוע. לדוגמה, 'LESS_WALKING' או google.maps.TransitRoutePreference.LESS_WALKING.

אפשר לגשת אליו באמצעות חיוג למספר const {TransitRoutePreference} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

FEWER_TRANSFERS מציין שהמסלול המחושב צריך להעדיף מספר מוגבל של החלפות.
LESS_WALKING מציינים שהמסלול המחושב צריך להעדיף כמויות מוגבלות של הליכה.

הממשק TransitFare

ממשק google.maps.TransitFare

מחיר של DirectionsRoute שמורכב מערך וממטבע.

currency
סוג:  string
קוד מטבע לפי תקן ISO 4217 שמציין את המטבע שבו מופיע המחיר.
value
סוג:  number
הערך המספרי של המחיר, שמבוטא ב-currency הנתון.

הממשק TransitDetails

ממשק google.maps.TransitDetails

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

arrival_stop
סוג:  TransitStop
התחנה שבה מגיעים בשלב הזה בתחבורה הציבורית.
arrival_time
סוג:  Time
זמן ההגעה של השלב הזה, שמצוין כאובייקט Time.
departure_stop
סוג:  TransitStop
התחנה שממנה יוצאים בשלב הזה בתחבורה הציבורית.
departure_time
סוג:  Time
זמן היציאה של השלב הזה, שמצוין כאובייקט Time.
headsign
סוג:  string
הכיוון שבו צריך לנסוע בקו הזה, כפי שהוא מסומן ברכב או בתחנת היציאה.
headway
סוג:  number
מספר השניות הצפוי בין כלי רכב דומים בתחנה הזו.
line
סוג:  TransitLine
פרטים על קו התחבורה הציבורית שבו נעשה שימוש בשלב הזה.
num_stops
סוג:  number
מספר העצירות בשלב הזה. כולל את תחנת העצירה של הנסיעה, אבל לא את תחנת העצירה של היציאה.
trip_short_name
סוג:  string
הטקסט שמופיע בלוחות זמנים ובשלטי נסיעה כדי לזהות נסיעה בתחבורה ציבורית לנוסעים, למשל, כדי לזהות מספרי רכבות לנסיעות ברכבת פרוורית. הטקסט מזהה באופן ייחודי נסיעה בתוך יום שירות.

הממשק TransitStop

ממשק google.maps.TransitStop

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

location
סוג:  LatLng
המיקום של התחנה הזו.
name
סוג:  string
השם של תחנת התחבורה הציבורית.

הממשק TransitLine

ממשק google.maps.TransitLine

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

agencies
סוג:  Array<TransitAgency>
חברת התחבורה הציבורית שמפעילה את קו התחבורה הציבורית הזה.
color
סוג:  string
הצבע הנפוץ בשימוש בשילוט של קו התחבורה הציבורית הזה, שמוצג כמחרוזת הקסדצימלית.
icon
סוג:  string
כתובת ה-URL של סמל שמשויך לקו הזה.
name
סוג:  string
השם המלא של קו התחבורה הציבורית, למשל '8 Avenue Local'.
short_name
סוג:  string
השם המקוצר של קו התחבורה הציבורית, למשל 'E'.
text_color
סוג:  string
צבע הטקסט שמקובל בדרך כלל בשילוט של קו התחבורה הציבורית הזה, שמוצג כמחרוזת הקסדצימלית.
url
סוג:  string
כתובת ה-URL של הסוכנות שספציפית לקו התחבורה הציבורית הזה.
vehicle
סוג:  TransitVehicle
סוג הרכב שבו השתמשתם, למשל רכבת או אוטובוס.

ממשק TransitAgency

ממשק google.maps.TransitAgency

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

name
סוג:  string
השם של חברת התחבורה הציבורית.
phone
סוג:  string
מספר הטלפון של חברת התחבורה הציבורית.
url
סוג:  string
כתובת ה-URL של חברת התחבורה הציבורית.

הממשק TransitVehicle

ממשק google.maps.TransitVehicle

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

icon
סוג:  string
כתובת URL של סמל שתואם לסוג הרכב שבו נעשה שימוש בקו הזה.
local_icon
סוג:  string
כתובת URL של סמל שתואם לסוג הרכב שמשמש באזור הזה, במקום הסמל הכללי יותר.
name
סוג:  string
שם לסוג הזה של TransitVehicle, למשל 'רכבת' או 'אוטובוס'.
type
סוג:  VehicleType
סוג הרכב שבו השתמשתם, למשל רכבת, אוטובוס או מעבורת.

קבועים של VehicleType

google.maps.VehicleType קבועים

ערכים אפשריים של סוגי כלי רכב.

אפשר לגשת אליו באמצעות חיוג למספר const {VehicleType} = await google.maps.importLibrary("routes"). ספריות ב-Maps JavaScript API

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

קבועים של UnitSystem

google.maps.UnitSystem קבועים

מערכות היחידות התקינות שאפשר לציין ב-DirectionsRequest.

אפשר לגשת אליו באמצעות חיוג למספר const {UnitSystem} = await google.maps.importLibrary("core"). ספריות ב-Maps JavaScript API

IMPERIAL מציין שצריך לציין את המרחקים ב-DirectionsResult ביחידות אימפריאליות.
METRIC מציין שהמרחקים ב-DirectionsResult צריכים להיכתב ביחידות מטריות.

ממשק Distance

ממשק google.maps.Distance

ייצוג המרחק כערך מספרי ומחרוזת תצוגה.

text
סוג:  string
ייצוג מחרוזת של ערך המרחק, באמצעות UnitSystem שצוין בבקשה.
value
סוג:  number
המרחק במטרים.

ממשק Duration

ממשק google.maps.Duration

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

text
סוג:  string
ייצוג מחרוזת של ערך משך הזמן.
value
סוג:  number
משך הזמן בשניות.

הממשק Time

ממשק google.maps.Time

ייצוג של זמן כאובייקט Date, כמחרוזת מותאמת לשוק המקומי וכאזור זמן.

text
סוג:  string
מחרוזת שמייצגת את ערך הזמן. השעה מוצגת באזור הזמן של תחנת התחבורה הציבורית.
time_zone
סוג:  string
אזור הזמן שבו נמצאת התחנה. הערך הוא שם אזור הזמן כפי שהוא מוגדר במסד הנתונים של אזור הזמן IANA, למשל 'America/New_York'.
value
סוג:  Date
השעה של היציאה או ההגעה, שצוינה כאובייקט Date של JavaScript.

קבועים של DirectionsTravelMode

google.maps.DirectionsTravelMode קבועים

קבועים של DirectionsUnitSystem

google.maps.DirectionsUnitSystem קבועים