Routes Data

מחלקה Route

class google.maps.routes.Route
library "routes"

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

const {Route} = await google.maps.importLibrary("routes");
computeRoutes
computeRoutes(request)
פרמטרים:
ערך מוחזר: Promise<{
  routes:Array<Route> optional,
  fallbackInfo:FallbackInfo optional,
  geocodingResults:GeocodingResults optional
}>
הפונקציה מחזירה את המסלול הראשי יחד עם מסלולים חלופיים אופציונליים, בהינתן קבוצה של נקודות ציון סופיות ונקודות ציון ביניים.

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

לדוגמה:
  • אנונימיזציה של כל השדות הזמינים: fields: ['*']
  • אנונימיזציה של שדות למשך, למרחק ולנתיב ברמת המסלול: fields: ['durationMillis', 'distanceMeters', 'path']

לא מומלץ להשתמש באנונימיזציה של שדות בתגובה עם תו כללי לחיפוש fields: ['*'] כי:
  • אם תבחרו רק את השדות שאתם צריכים, השרת שלנו יחסוך מחזורי חישוב, וכך נוכל להחזיר לכם את התוצאה עם זמן אחזור קצר יותר.
  • כדי להבטיח ביצועי זמן אחזור יציבים, בחרו רק את השדות שאתם צריכים במשימת הייצור. יכול להיות שנוסיף עוד שדות תגובה בעתיד, והשדות החדשים האלה עשויים לדרוש זמן חישוב נוסף. אם תבחרו את כל השדות, או את כל השדות ברמה העליונה, יכול להיות שתהיה ירידה בביצועים כי כל שדה חדש שנוסיף ייכלל באופן אוטומטי בתגובה.
  • אם תבחרו רק את השדות שאתם צריכים, התגובה תהיה קטנה יותר, ולכן היא תיטען מהר יותר ברשת.
description
readonly
סוג: string optional
תיאור של המסלול.
distanceMeters
readonly
סוג: number optional
מרחק הנסיעה של המסלול, במטרים.
durationMillis
readonly
סוג: number optional
משך הזמן שנדרש כדי לנווט במסלול, באלפיות השנייה. אם מגדירים את ComputeRoutesRequest.routingPreference כ-TRAFFIC_UNAWARE, הערך הזה זהה ל-Route.staticDurationMillis. אם מגדירים את ComputeRoutesRequest.routingPreference לערך TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, הערך הזה מחושב תוך התחשבות במצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
legs
readonly
סוג: Array<RouteLeg> optional
אוסף של מקטעים (קטעי מסלול בין נקודות ציון) שמרכיבים את המסלול. כל קטע תואם לנסיעה בין שתי נקודות ציון שאינן via.

לדוגמה:
  • במסלול בלי נקודות ציון ביניים יש רק מקטע אחד.
  • במסלול שכולל נקודת ציון אחת שהיא לא via יש שני מקטעים.
  • מסלול שכולל נקודת ציון אחת (via) באמצע הדרך מכיל מקטע אחד.
סדר המקטעים תואם לסדר של נקודות הדרך מ-origin אל intermediates ואז אל destination.
localizedValues
readonly
סוג: RouteLocalizedValues optional
ייצוגים בטקסט של מאפייני Route.
optimizedIntermediateWaypointIndices
readonly
סוג: Array<number> optional
אם מגדירים את ComputeRoutesRequest.optimizeWaypointOrder לערך true, השדה הזה מכיל את הסדר האופטימלי של ציוני הדרך. אחרת, השדה הזה ריק. האינדקס מתחיל ב-0 עבור נקודת הביניים הראשונה שצוינה בקלט.

לדוגמה, אם הקלט הוא:
  • מקור: לוס אנג'לס
  • נקודות ביניים: דאלאס, בנגור, פיניקס
  • יעד: ניו יורק
והסדר האופטימלי של נקודות הציון הוא פיניקס, דאלאס, בנגור, השדה הזה יהיה [2, 0, 1].
path
readonly
סוג: Array<LatLngAltitude> optional
רשימת ה-LatLngAltitude של המסלול, שבה אפשר להשתמש כדי לשרטט קו פוליגוני של המסלול. אפשר לשלוט ברמת הפירוט של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality.
polylineDetails
readonly
סוג: PolylineDetails optional
מכיל מידע על פרטים לאורך המסלול.
routeLabels
readonly
סוג: Array<RouteLabel> optional
תוויות למסלול שמועילות לזיהוי מאפיינים ספציפיים או להשוואה בין מסלולים.
routeToken
readonly
סוג: string optional
אסימון אטום שאפשר להעביר ל-Navigation SDK כדי לשחזר את המסלול במהלך הניווט, ובמקרה של שינוי מסלול, לכבד את הכוונה המקורית כשהמסלול נוצר. התייחסו לטוקן הזה כאל אובייקט BLOB אטום. אל תשוו את הערך שלו בין בקשות, כי הערך עשוי להשתנות גם אם השירות מחזיר בדיוק את אותו מסלול.

הערה: routeToken זמין רק לבקשות שבהן ComputeRoutesRequest.routingPreference מוגדר ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL. הוא לא נתמך בבקשות עם via נקודות ציון.
speedPaths
readonly
סוג: Array<SpeedPath> optional
קבוצות של קטעים בנתיב המסלול עם קריאת המהירות המתאימה להם. כדי שהשדה הזה יאוכלס, צריך להגדיר את ComputeRoutesRequest.routingPreference ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL, ו-ComputeRoutesRequest.extraComputations צריך לכלול את TRAFFIC_ON_POLYLINE.
staticDurationMillis
readonly
סוג: number optional
משך הנסיעה במסלול בלי להביא בחשבון את מצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
travelAdvisory
readonly
סוג: RouteTravelAdvisory optional
מידע נוסף על המסלול.
viewport
readonly
סוג: LatLngBounds optional
התיבה התוחמת של אזור התצוגה של המסלול.
warnings
readonly
סוג: Array<string> optional
מערך של אזהרות שיוצגו כשמציגים את המסלול.
Alphacreate3DPolylines
create3DPolylines([options])
פרמטרים:
ערך מוחזר: Promise<Array<Polyline3DElement>>
יוצר קווים פוליגוניים תלת-ממדיים למסלול על סמך הנתונים שזמינים למסלול.
createPolylines
createPolylines([options])
פרמטרים:
ערך מוחזר: Array<Polyline>
יצירת קווים פוליגוניים למסלול על סמך הנתונים הזמינים.

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

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

קו פוליגוני כולל:
  • דרישות:
  • יוצר קו פוליגוני אחד לכל המסלול עם סגנון ברירת המחדל. אפשר להעביר אפשרויות כדי לשנות את הסגנון של הקו הפוליגוני בהתאם לאמצעי התחבורה במסלול. כדי להתאים אישית את הקווים הפוליגוניים, אפשר ליצור אותם ישירות באמצעות Route.path או RouteLeg.path.
AlphacreatePopover
createPopover()
פרמטרים: אין
ערך מוחזר: Promise<PopoverElement>
יצירת חלון קופץ למסלול על סמך הנתונים שזמינים למסלול, שמוגדר באופן שמתאים להוספת הערות למסלול במפה. כרגע משתמש ב-Route.localizedValues, ב-Route.path וב-Route.legs, אם הם זמינים.
createWaypointAdvancedMarkers
createWaypointAdvancedMarkers([options])
ערך מוחזר: Promise<Array<AdvancedMarkerElement>>
יוצרת סמנים למסלול עם התוויות 'A',‏ 'B',‏ 'C' וכו' לכל נקודת דרך. לסמנים יש סגנון ברירת מחדל. אפשר להעביר אפשרויות כדי לשנות את סגנון הסמן על סמך האינדקס של הסמן או המאפיינים של ה-RouteLeg התואם. הפרמטר WaypointMarkerDetails.leg לא יהיה מוגדר אם למסלול אין מקטעים.

צריך לבקש את השדה "legs" ב-ComputeRoutesRequest.fields כדי לכלול נקודות ציון ביניים.
AlphacreateWaypointMarkers
פרמטרים:
ערך מוחזר: Promise<Array<T>>
יוצרת סמנים לנקודת המוצא וליעד של המסלול. לסמנים יש סגנון ברירת מחדל, אלא אם צוינה פונקציית customOverride. בשלב הזה אין תמיכה בנקודות ציון ביניים.

כברירת מחדל, הערך של CollisionBehavior בסמנים שנוצרו מוגדר כ-CollisionBehavior.REQUIRED_AND_HIDES_OPTIONAL. כברירת מחדל, לסמנים שנוצרו יש title ("מוצא" או "יעד") מותאם לשוק המקומי, שאפשר לשנות ב-forEach. בסמנים Marker3DElement ו-Marker3DInteractiveElement, הערך של sizePreserved מוגדר כ-true כברירת מחדל, ואפשר לשנות אותו גם ב-forEach.
בירושה: toJSON

ממשק ComputeRoutesRequest

ממשק google.maps.routes.ComputeRoutesRequest

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

destination
היעד של המסלול. ערך שמועבר כמחרוזת יכול להיות כתובת, Plus Code או שם של משאב מקום. ערכי הגובה לא נלקחים בחשבון בחישוב המסלולים.
fields
סוג: Iterable<string>
אוסף של שדות לאחזור. מציינים ["*"] בכל השדות.
origin
נקודת המוצא של המסלול. ערך שמועבר כמחרוזת יכול להיות כתובת, Plus Code או שם של משאב מקום. ערכי הגובה לא נלקחים בחשבון בחישוב המסלולים.
arrivalTime
אופציונלי
סוג: Date optional
זמן ההגעה.

הערה: אפשר להגדיר את המדיניות הזו רק אם המדיניות ComputeRoutesRequest.travelMode מוגדרת לערך TRANSIT. אפשר לציין את ComputeRoutesRequest.departureTime או את ComputeRoutesRequest.arrivalTime, אבל לא את שניהם. אפשר לראות נסיעות בתחבורה ציבורית עד 7 ימים בעבר או עד 100 ימים בעתיד.
computeAlternativeRoutes
אופציונלי
סוג: boolean optional
מציין אם לחשב מסלולים חלופיים בנוסף למסלול. לא מוחזרים מסלולים חלופיים לבקשות שיש בהן נקודות ביניים.
departureTime
אופציונלי
סוג: Date optional
שעת היציאה. אם לא תגדירו את הערך הזה, המערכת תשתמש כברירת מחדל בחותמת הזמן של הבקשה.

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

הערה: החישובים הנוספים האלה עשויים להחזיר שדות נוספים בתגובה. כדי שהשדות הנוספים האלה יוחזרו בתגובה, צריך לציין אותם גם ב-ComputeRoutesRequest.fields.
intermediates
אופציונלי
סוג: Iterable<Waypoint> optional
קבוצה של נקודות ציון לאורך המסלול (לא כולל נקודות קצה), לעצירה או למעבר. אפשר להוסיף עד 25 נקודות ציון ביניים.
internalUsageAttributionIds
אופציונלי
סוג: Iterable<string> optional
מזהים שמשמשים לשיוך קריאות לחבילות ספציפיות או לספריות OSS.
language
אופציונלי
סוג: string optional
קוד השפה בתקן BCP-47, למשל "en-US" או "sr-Latn". מידע נוסף זמין במאמר מזהה לוקאל של Unicode. כאן מפורטות השפות שבהן אפשר לקבל תמיכה. אם לא תציינו את הערך הזה, השפה תוסק מהגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, השפה נקבעת לפי המיקום של המקור.
optimizeWaypointOrder
אופציונלי
סוג: boolean optional
אם הערך הוא true, השירות מנסה לצמצם את העלות הכוללת של המסלול על ידי שינוי הסדר של נקודות הדרך שצוינו. הבקשה נכשלת אם אחת מנקודות הדרך היא נקודת מעבר. משתמשים ב-Route.optimizedIntermediateWaypointIndices בתשובה כדי למצוא את הסדר החדש. אם לא מבקשים את "optimizedIntermediateWaypointIndices" ב-ComputeRoutesRequest.fields, הבקשה נכשלת. אם המדיניות מוגדרת כ-False, השדה Route.optimizedIntermediateWaypointIndices בתגובה יהיה ריק.
polylineQuality
אופציונלי
סוג: PolylineQuality optional
מציינת את ההעדפה לאיכות הקו הפוליגוני.
region
אופציונלי
סוג: string optional
קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. מידע נוסף זמין במאמר דומיינים ברמה העליונה עם קוד מדינה (ccTLD). אם לא תספקו את הערך הזה, האזור יוסק מהגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, האזור נקבע לפי המיקום של המקור.
requestedReferenceRoutes
אופציונלי
סוג: Iterable<ReferenceRoute> optional
מציין אילו מסלולי עזר לחשב כחלק מהבקשה, בנוסף למסלול ברירת המחדל. מסלול עזר הוא מסלול עם יעד חישוב מסלול שונה מהמסלול שמוגדר כברירת מחדל. לדוגמה, חישוב מסלול לדוגמה של FUEL_EFFICIENT מביא בחשבון פרמטרים שונים שיפיקו מסלול אופטימלי לחיסכון בדלק. כשמשתמשים בתכונה הזו, צריך לחפש את הסמל Route.routeLabels במסלולים שמוצגים.
routeModifiers
אופציונלי
סוג: RouteModifiers optional
קבוצת תנאים שמשפיעים על אופן חישוב המסלולים. לדוגמה, אפשר לציין מאפיינים שרוצים להימנע מהם, כמו כבישי אגרה או כבישים מהירים.
routingPreference
אופציונלי
סוג: RoutingPreference optional
מציינת איך לחשב את המסלול. השרת מנסה להשתמש בהעדפת המסלול שנבחרה כדי לחשב את המסלול. אם העדפת הניתוב גורמת לשגיאה או לזמן אחזור ארוך במיוחד, תוחזר שגיאה. אפשר לציין את האפשרות הזו רק כשהערך של ComputeRoutesRequest.travelMode הוא DRIVING או TWO_WHEELER, אחרת הבקשה תיכשל.
trafficModel
אופציונלי
סוג: TrafficModel optional
מציין את ההנחות שצריך להשתמש בהן כשמחשבים את הזמן בתנועה. ההגדרה הזו משפיעה על הערך של Route.durationMillis ו-RouteLeg.durationMillis, שמכילים את הזמן החזוי בתנועה על סמך ממוצעים היסטוריים. השדה ComputeRoutesRequest.trafficModel זמין רק לבקשות שבהן השדה ComputeRoutesRequest.routingPreference מוגדר כ-TRAFFIC_AWARE_OPTIMAL והשדה ComputeRoutesRequest.travelMode מוגדר כ-DRIVING. ברירת המחדל היא BEST_GUESS.
transitPreference
אופציונלי
סוג: TransitPreference optional
מציינת העדפות שמשפיעות על המסלול שמוחזר למסלולי TRANSIT.

הערה: אפשר לציין את זה רק כש-ComputeRoutesRequest.travelMode מוגדר ל-TRANSIT.
travelMode
אופציונלי
סוג: TravelMode optional
מציין את אמצעי התחבורה.
units
אופציונלי
סוג: UnitSystem optional
מציינת את יחידות המידה של שדות התצוגה, כמו הוראות ניווט. יחידות המידה שמשמשות למסלול, למקטע, למרחק של השלב ולמשך הזמן לא מושפעות מהערך הזה. אם לא תספקו את הערך הזה, יחידות התצוגה יוסקו מהמיקום של נקודת המוצא.

קבועים של ComputeRoutesExtraComputation

constants google.maps.routes.ComputeRoutesExtraComputation
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג ComputeRoutesExtraComputationString.

const {ComputeRoutesExtraComputation} = await google.maps.importLibrary("routes");
FLYOVER_INFO_ON_POLYLINE מידע על גשרים במסלולים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
FUEL_CONSUMPTION צריכת הדלק המשוערת במסלולים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
HTML_FORMATTED_NAVIGATION_INSTRUCTIONS מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
NARROW_ROAD_INFO_ON_POLYLINE מידע על כבישים צרים במסלולים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TOLLS מידע על אגרות במסלולים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TRAFFIC_ON_POLYLINE קווים פוליגוניים מודעים לתנועה עבור המסלולים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

הממשק CreateWaypointMarkersOptions

ממשק google.maps.routes.CreateWaypointMarkersOptions<T = MarkerElement|Marker3DElement|MarkerInteractiveElement|Marker3DInteractiveElement>

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

forEach
אופציונלי
סוג: function(T): void optional
פונקציה מותאמת אישית לשינוי הרכיבים שנוצרו. פונקציית ברירת המחדל forEach מוסיפה סיכות עם גליפים של A-Z לכל סמן. כדי לשנות את ההתנהגות, צריך לשנות את הפונקציה הזו.
markerClass
אופציונלי
סוג: new () => T optional
ה-constructor של הרכיב שרוצים ליצור. סוגי הקבצים הנתמכים כוללים:

ממשק DirectionalLocationLiteral

ממשק google.maps.routes.DirectionalLocationLiteral מרחיב את LatLngAltitudeLiteral, LatLngLiteral
מוטמע על ידי DirectionalLocation

כדי להקל על המשתמשים, אפשר להשתמש בליטרלים של אובייקטים במקום במופעים של DirectionalLocation. הן מומרות ל-DirectionalLocation כש-Maps JS API נתקל בהן.

heading
אופציונלי
סוג: number optional
כיוון המצפן שמשויך לכיוון זרימת התנועה. ערכי הכיוון יכולים להיות מספרים מ-0 עד 360, כאשר 0 מציין כיוון צפון, 90 מציין כיוון מזרח וכן הלאה. אפשר להשתמש בשדה הזה רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode.
ירושה: altitude, lat, lng

המחלקה DirectionalLocation

class google.maps.routes.DirectionalLocation extends LatLngAltitude implements DirectionalLocationLiteral, LatLngAltitudeLiteral, LatLngLiteral
library "routes"

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

const {DirectionalLocation} = await google.maps.importLibrary("routes");
בירושה: LatLngAltitude
heading
readonly
סוג: number optional
כיוון המצפן שמשויך לכיוון זרימת התנועה. ערכי הכיוון יכולים להיות מספרים מ-0 עד 360, כאשר 0 מציין כיוון צפון, 90 מציין כיוון מזרח וכן הלאה. אפשר להשתמש בשדה הזה רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode.
ירושה: altitude, lat, lng
toJSON
toJSON([key])
פרמטרים:
  • key: string optional
ערך מוחזר: DirectionalLocationLiteral
הפונקציה ממירה לאובייקט פשוט.
בירושה: equals

המחלקה FallbackInfo

class google.maps.routes.FallbackInfo
library "routes"

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

const {FallbackInfo} = await google.maps.importLibrary("routes");
reason
readonly
סוג: FallbackReason optional
הסיבה לכך שהמערכת השתמשה בתגובה חלופית במקום בתגובה המקורית. השדה הזה מאוכלס רק כשמצב החלופה מופעל ומוחזרת תגובת החלופה.
routingMode
readonly
סוג: FallbackRoutingMode optional
מצב הניתוב ששימש לתגובה. אם הופעל החלופה, יכול להיות שהמצב יהיה שונה מהעדפת הניתוב שהוגדרה בבקשת הלקוח המקורית.
בירושה: toJSON

קבועים של FallbackReason

constants google.maps.routes.FallbackReason
ספרייה "routes"

הסיבות לשימוש בתגובה חלופית. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג FallbackReasonString.

const {FallbackReason} = await google.maps.importLibrary("routes");
LATENCY_EXCEEDED לא הצלחנו לסיים את החישוב בזמן עם מצב הניתוב המועדף עליך, אבל הצלחנו להחזיר תוצאה שחושבה במצב חלופי. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
SERVER_ERROR אירעה שגיאה בחיבור לשרת בזמן חישוב המסלולים באמצעות מצב הניתוב המועדף, אבל הצלחנו להחזיר תוצאה שחושבה באמצעות מצב חלופי. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

קבועים של FallbackRoutingMode

constants google.maps.routes.FallbackRoutingMode
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג FallbackRoutingModeString.

const {FallbackRoutingMode} = await google.maps.importLibrary("routes");
TRAFFIC_AWARE מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TRAFFIC_UNAWARE מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

המחלקה GeocodedWaypoint

class google.maps.routes.GeocodedWaypoint
library "routes"

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

const {GeocodedWaypoint} = await google.maps.importLibrary("routes");
geocoderStatus
readonly
סוג: RPCStatus optional
מציין את קוד הסטטוס שנוצר כתוצאה מהפעולה של המרת הכתובת לקואורדינטות.
intermediateWaypointRequestIndex
readonly
סוג: number optional
האינדקס של נקודת הדרך המתאימה בבקשה. השדה הזה מאוכלס רק אם נקודת הדרך המתאימה היא נקודת דרך ביניים.
partialMatch
readonly
סוג: boolean
מציין שהכלי להמרת כתובות לקואורדינטות לא החזיר התאמה מדויקת לבקשה המקורית, אבל הצליח להתאים חלק מהכתובת המבוקשת. כדאי לבדוק אם יש שגיאות כתיב בבקשה המקורית או אם הכתובת לא מלאה.
placeId
readonly
סוג: string
מזהה המקום של התוצאה הזו.
types
readonly
סוג: Array<string>
סוגי התוצאות, בצורה של אפס או יותר תגי סוג. בכתובת https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types מפורטים הסוגים הנתמכים.
בירושה: toJSON

GeocodingResults class

class google.maps.routes.GeocodingResults
library "routes"

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

const {GeocodingResults} = await google.maps.importLibrary("routes");
destination
readonly
סוג: GeocodedWaypoint optional
ציון הדרך של היעד שהומרה לקואורדינטות.
intermediates
readonly
סוג: Array<GeocodedWaypoint> optional
רשימה של נקודות ביניים שהומרו לקואורדינטות, שכל אחת מהן מכילה שדה אינדקס שתואם למיקום של ציון הדרך לפי הסדר שבו הוא צוין בבקשה, החל מ-0.
origin
readonly
סוג: GeocodedWaypoint optional
ציון הדרך של המוצא שהומר לקואורדינטות.
בירושה: toJSON

המחלקה MultiModalSegment

class google.maps.routes.MultiModalSegment
library "routes"

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

const {MultiModalSegment} = await google.maps.importLibrary("routes");
instructions
readonly
סוג: string optional
הוראות לניווט בקטע הזה שכולל כמה אמצעי תחבורה.
maneuver
readonly
סוג: string optional
התמרון בניווט שצריך לבצע בשלב הזה. בקטע תמרון תוכלו לעיין ברשימה של הערכים האפשריים.
stepEndIndex
readonly
סוג: number
האינדקס התואם של RouteLegStep שמציין את הסוף של קטע מולטי-מודאלי.
stepStartIndex
readonly
סוג: number
האינדקס התואם של RouteLegStep שמציין את ההתחלה של קטע מולטי-מודאלי.
travelMode
readonly
סוג: TravelMode optional
אמצעי התחבורה שמשמש למקטע המולטי-מודאלי הזה.
בירושה: toJSON

המחלקה PolylineDetailInfo

class google.maps.routes.PolylineDetailInfo
library "routes"

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

const {PolylineDetailInfo} = await google.maps.importLibrary("routes");
endIndex
readonly
סוג: number optional
אינדקס הסיום של מאפיין הכביש הזה בקו הפוליגוני.
presence
readonly
סוג: RoadFeatureState optional
מציין אם מאפיין הכביש קיים לאורך הקו הפוליגוני.
startIndex
readonly
סוג: number optional
אינדקס ההתחלה של מאפיין הכביש הזה בקו הפוליגוני.
בירושה: toJSON

הכיתה PolylineDetails

class google.maps.routes.PolylineDetails
library "routes"

פרטים שתואמים לאינדקס נתון או לקטע רציף של קו פוליגוני. אם יש קו פוליגוני עם הנקודות P_0, ‏ P_1,‏ ... , ‏ P_N (אינדקס מבוסס-אפס), PolylineDetails מתאר מאפיין של כביש במרווח זמן נתון.

const {PolylineDetails} = await google.maps.importLibrary("routes");
flyoverInfo
readonly
פרטי המעוף לאורך הקו הפוליגוני.
narrowRoadInfo
readonly
פרטי הכביש הצר לאורך הקו הפוליגוני.
בירושה: toJSON

קבועים של PolylineQuality

constants google.maps.routes.PolylineQuality
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג PolylineQualityString.

const {PolylineQuality} = await google.maps.importLibrary("routes");
HIGH_QUALITY מציין קו פוליגוני באיכות גבוהה – שמורכב מיותר נקודות מאשר OVERVIEW, על חשבון גודל תגובה גדול יותר. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
OVERVIEW מציין קו פוליגוני של סקירה כללית – שמורכב ממספר קטן של נקודות. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

קבועים של ReferenceRoute

constants google.maps.routes.ReferenceRoute
ספרייה "routes"

מסלול עזר נתמך ב-ComputeRoutesRequest. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג ReferenceRouteString.

const {ReferenceRoute} = await google.maps.importLibrary("routes");
FUEL_EFFICIENT מסלול חסכוני בדלק. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
SHORTER_DISTANCE מסלול עם מרחק נסיעה קצר יותר. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

קבועים של RoadFeatureState

constants google.maps.routes.RoadFeatureState
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג RoadFeatureStateString.

const {RoadFeatureState} = await google.maps.importLibrary("routes");
DOES_NOT_EXIST הכביש לא קיים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
EXISTS מאפיין הכביש קיים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

קבועים של RouteLabel

constants google.maps.routes.RouteLabel
ספרייה "routes"

מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג RouteLabelString.

const {RouteLabel} = await google.maps.importLibrary("routes");
DEFAULT_ROUTE המסלול "הטוב ביותר" שמוחזר כברירת מחדל בחישוב המסלול. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
DEFAULT_ROUTE_ALTERNATE חלופה למסלול "הטוב ביותר" שמוגדר כברירת מחדל. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
FUEL_EFFICIENT מסלול חסכוני בדלק. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
SHORTER_DISTANCE מסלול עם מרחק נסיעה קצר יותר. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

המחלקה RouteLeg

class google.maps.routes.RouteLeg
library "routes"

מכיל קטע בין נקודות ציון שאינן via.

const {RouteLeg} = await google.maps.importLibrary("routes");
distanceMeters
readonly
סוג: number
מרחק הנסיעה של מקטע המסלול, במטרים.
durationMillis
readonly
סוג: number optional
משך הזמן שנדרש כדי לנווט במקטע המסלול, באלפיות השנייה. אם מגדירים את ComputeRoutesRequest.routingPreference כ-TRAFFIC_UNAWARE, הערך הזה זהה ל-staticDurationMillis. אם מגדירים את ComputeRoutesRequest.routingPreference לערך TRAFFIC_AWARE או TRAFFIC_AWARE_OPTIMAL, הערך הזה מחושב תוך התחשבות במצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
endLocation
readonly
סוג: DirectionalLocation optional
מיקום הסיום של המקטע הזה. יכול להיות שהמיקום הזה שונה מהמיקום של ComputeRoutesRequest.destination. לדוגמה, אם ComputeRoutesRequest.destination לא נמצא ליד כביש, זו נקודה על הכביש.
localizedValues
readonly
סוג: RouteLegLocalizedValues optional
ייצוגים בטקסט של מאפייני RouteLeg.
path
readonly
רשימת ה-LatLngAltitude של מקטע המסלול, שבה אפשר להשתמש כדי לשרטט קו פוליגוני של מקטע המסלול. אפשר לשלוט ברמת הפירוט של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality.
speedPaths
readonly
סוג: Array<SpeedPath>
קיבוץ של קטעים בנתיב של מקטע המסלול עם קריאת המהירות המתאימה. כדי שהשדה הזה יאוכלס, צריך להגדיר את ComputeRoutesRequest.routingPreference ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL, ו-ComputeRoutesRequest.extraComputations צריך לכלול את TRAFFIC_ON_POLYLINE.
startLocation
readonly
סוג: DirectionalLocation optional
מיקום ההתחלה של המקטע הזה. יכול להיות שהמיקום הזה שונה מהמיקום של ComputeRoutesRequest.origin. לדוגמה, אם ComputeRoutesRequest.origin לא נמצא ליד כביש, זו נקודה על הכביש.
staticDurationMillis
readonly
סוג: number optional
משך הנסיעה בקטע בלי להביא בחשבון את מצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
steps
readonly
מערך של שלבים שמציינים מקטעים בתוך החלק הזה. כל שלב מייצג הוראת ניווט אחת.
stepsOverview
readonly
סוג: StepsOverview optional
סקירה כללית של השלבים בRouteLeg הזה. השדה הזה מאוכלס רק במסלולי TRANSIT.
travelAdvisory
readonly
סוג: RouteLegTravelAdvisory optional
מכיל את המידע הנוסף שצריך להודיע למשתמש עליו, כמו הגבלות אפשריות על אזורי תנועה, בקטע של מסלול.
בירושה: toJSON

המחלקה RouteLegLocalizedValues

class google.maps.routes.RouteLegLocalizedValues
library "routes"

ייצוגי טקסט של RouteLeg.

const {RouteLegLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
סוג: string optional
מרחק הנסיעה של מקטע המסלול בפורמט טקסט.
distanceLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט המרחק, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
readonly
סוג: string optional
משך הזמן, מיוצג בפורמט טקסט ומותאם לאזור של השאילתה. לוקח בחשבון את מצב התנועה.
durationLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט משך הזמן, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
readonly
סוג: string optional
משך הזמן בלי להביא בחשבון את מצב התנועה, מיוצג בפורמט טקסט.
staticDurationLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של הטקסט הסטטי של משך הזמן, למשל "en-US" או "sr-Latn".
בירושה: toJSON

המחלקה RouteLegStep

class google.maps.routes.RouteLegStep
library "routes"

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

const {RouteLegStep} = await google.maps.importLibrary("routes");
distanceMeters
readonly
סוג: number
מרחק הנסיעה של השלב הזה, במטרים.
endLocation
readonly
סוג: DirectionalLocation optional
מיקום הסיום של השלב הזה.
instructions
readonly
סוג: string optional
הוראות לניווט בשלב הזה.
localizedValues
readonly
ייצוגים בטקסט של מאפייני RouteLegStep.
maneuver
readonly
סוג: string optional
התמרון בניווט שצריך לבצע בשלב הזה. בקטע תמרון תוכלו לעיין ברשימה של הערכים האפשריים.
path
readonly
רשימת LatLngAltitude של השלב במקטע המסלול, שבה אפשר להשתמש כדי לשרטט קו פוליגוני של השלב במקטע המסלול. אפשר לשלוט ברמת הפירוט של הנתיב באמצעות ההגדרה ComputeRoutesRequest.polylineQuality. כדי שהשדה הזה יאוכלס, צריך לבקש את השדה "path" ב-ComputeRoutesRequest.fields.
startLocation
readonly
סוג: DirectionalLocation optional
מיקום ההתחלה של השלב הזה.
staticDurationMillis
readonly
סוג: number optional
משך הנסיעה בשלב הזה בלי להביא בחשבון את מצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
transitDetails
readonly
סוג: TransitDetails optional
פרטים שקשורים לשלב הזה אם אמצעי התחבורה הוא TRANSIT.
travelMode
readonly
סוג: TravelMode optional
אמצעי התחבורה שמשמש לשלב הזה.
בירושה: toJSON

המחלקה RouteLegStepLocalizedValues

class google.maps.routes.RouteLegStepLocalizedValues
library "routes"

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

const {RouteLegStepLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
סוג: string optional
מרחק הנסיעה של השלב במקטע המסלול, בפורמט טקסט.
distanceLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט המרחק, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
readonly
סוג: string optional
משך הזמן בלי להביא בחשבון את מצב התנועה, מיוצג בפורמט טקסט.
staticDurationLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של הטקסט הסטטי של משך הזמן, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
בירושה: toJSON

המחלקה RouteLegTravelAdvisory

class google.maps.routes.RouteLegTravelAdvisory
library "routes"

מכיל מידע נוסף שצריך להודיע עליו למשתמש ב-RouteLeg.

const {RouteLegTravelAdvisory} = await google.maps.importLibrary("routes");
speedReadingIntervals
readonly
סוג: Array<SpeedReadingInterval> optional
מרווחי קריאת מהירות שמפרטים את צפיפות התנועה. רלוונטי במקרה של TRAFFIC_AWARE ו-TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routingPreference. המרווחים מכסים את כל הקו הפוליגוני של RouteLeg בלי חפיפה. נקודת ההתחלה של מרווח זמן מסוים זהה לנקודת הסיום של מרווח הזמן הקודם.

דוגמה:
 polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G)
tollInfo
readonly
סוג: TollInfo optional
מכיל מידע על אגרות בRouteLeg הספציפי. השדה הזה מאוכלס רק אם צפויים כבישי אגרה בRouteLeg. אם השדה הזה מוגדר אבל השדה TollInfo.estimatedPrices לא מאוכלס, מקטע המסלול כולל כבישי אגרה אבל המחיר המשוער לא ידוע. אם השדה הזה ריק, אין כבישי אגרה בRouteLeg.
בירושה: toJSON

המחלקה RouteLocalizedValues

class google.maps.routes.RouteLocalizedValues
library "routes"

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

const {RouteLocalizedValues} = await google.maps.importLibrary("routes");
distance
readonly
סוג: string optional
מרחק הנסיעה במסלול, מיוצג בפורמט טקסט.
distanceLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט המרחק, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
readonly
סוג: string optional
משך הזמן, מיוצג בפורמט טקסט ומותאם לאזור של השאילתה. לוקח בחשבון את מצב התנועה. הערה: אם לא ביקשתם מידע על התנועה, הערך הזה זהה לערך של staticDuration.
durationLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט משך הזמן, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
readonly
סוג: string optional
משך הזמן בלי להביא בחשבון את מצב התנועה, מיוצג בפורמט טקסט.
staticDurationLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של הטקסט הסטטי של משך הזמן, למשל "en-US" או "sr-Latn".
transitFare
readonly
סוג: string optional
תעריף הנסיעה בתחבורה הציבורית מיוצג בפורמט טקסט.
transitFareLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של הטקסט של תעריף הנסיעה, למשל "en-US" או "sr-Latn".
בירושה: toJSON

ממשק RouteModifiers

ממשק google.maps.routes.RouteModifiers

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

avoidFerries
אופציונלי
סוג: boolean optional
כשהערך הוא true, המערכת נמנעת ממעבורות כשאפשר, ומעדיפה מסלולים שלא כוללים מעבורות. ההגדרה חלה רק על DRIVING או TWO_WHEELER TravelMode.
avoidHighways
אופציונלי
סוג: boolean optional
כשהערך הוא true, המערכת נמנעת מכבישים מהירים כשאפשר, ונותנת עדיפות למסלולים שלא כוללים כבישים מהירים. ההגדרה חלה רק על DRIVING או TWO_WHEELER TravelMode.
avoidIndoor
אופציונלי
סוג: boolean optional
כשהערך הוא true, המערכת נמנעת מניווט בתוך מבנים כשאפשר, ומעדיפה מסלולים שלא כוללים ניווט בתוך מבנים. ההגדרה רלוונטית רק ל-WALKING TravelMode.
avoidTolls
אופציונלי
סוג: boolean optional
כשהערך הוא true, המערכת נמנעת מכבישי אגרה כשאפשר, ומעדיפה מסלולים שלא כוללים כבישי אגרה. ההגדרה חלה רק על DRIVING או TWO_WHEELER TravelMode.
tollPasses
אופציונלי
סוג: Iterable<string> optional
מכיל מידע על מינויים לכבישי אגרה. אם מספקים מינויים לכבישי אגרה, ה-API מנסה להחזיר את מחיר המינוי. אם לא מציינים מינויים לכבישי אגרה, ה-API מתייחס למינוי לכביש האגרה כלא ידוע ומנסה להחזיר את המחיר במזומן. ההגדרה חלה רק על DRIVING או TWO_WHEELER TravelMode. רשימה של ערכים תקינים מופיעה במאמר TollPass.
vehicleInfo
אופציונלי
סוג: VehicleInfo optional
מציינת את פרטי הרכב.

הממשק RoutePolyline3DOptions

ממשק google.maps.routes.RoutePolyline3DOptions

אפשרויות ליצירת קווים פוליגוניים תלת-ממדיים של מסלולים.

polylineOptions
אופציונלי
אפשרויות להתאמה אישית של הסגנון של קו פוליגוני תלת-ממדי.
trafficPolylinesDisabled
אופציונלי
סוג: boolean optional
אם להשבית קווים פוליגוניים מודעים לתנועה. קווים פוליגוניים שמבוססים על מצב התנועה זמינים רק כש-routingPreference מוגדר ל-TRAFFIC_AWARE או ל-TRAFFIC_AWARE_OPTIMAL.

ממשק RoutePolylineDetails

ממשק google.maps.routes.RoutePolylineDetails

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

speed
אופציונלי
סוג: Speed optional
קריאת המהירות של קטע המסלול שתואם לקו הפוליגוני הזה. השדה הזה מאוכלס רק במסלולים עם מידע על מצב התנועה.
transitDetails
אופציונלי
סוג: TransitDetails optional
פרטי התחבורה הציבורית של קטע המסלול שתואם לקו הפוליגוני הזה. השדה הזה מאוכלס רק במסלולים עם מידע על תחבורה ציבורית.
travelMode
אופציונלי
סוג: TravelMode optional
אמצעי התחבורה בקטע של המסלול שתואם לקו הפוליגוני הזה. ריק לקווים פוליגוניים של תנועה.

ממשק RoutePolylineOptions

ממשק google.maps.routes.RoutePolylineOptions

אפשרויות ליצירת קווים פוליגוניים של מסלולים.

colorScheme
אופציונלי
סוג: ColorScheme optional
ערכת הצבעים של הקו הפוליגוני. אם מציינים FOLLOW_SYSTEM כשהמפה colorScheme היא גם FOLLOW_SYSTEM, הקווים הפוליגוניים ישורטטו באותו מצב כהה/בהיר כמו המפה. אם לא מציינים שפה, Route.createPolylines מנסה להשתמש בcolorScheme של המפה או חוזר לברירת המחדל של המערכת.
polylineOptions
אופציונלי
אפשרויות להתאמה אישית של הסגנון של קו פוליגוני. יכול להיות אובייקט PolylineOptions שמוחל על כל הקווים הפוליגוניים של המסלול, או פונקציה שמקבלת את ברירות המחדל PolylineOptions ו-RoutePolylineDetails ומחזירה את PolylineOptions שיוחל על הקו הפוליגוני הזה.

המחלקה RouteTravelAdvisory

class google.maps.routes.RouteTravelAdvisory
library "routes"

מכיל מידע נוסף שצריך להודיע עליו למשתמש ב-Route.

const {RouteTravelAdvisory} = await google.maps.importLibrary("routes");
fuelConsumptionMicroliters
readonly
סוג: number optional
צריכת הדלק החזויה במיקרוליטרים.

הערה: אם צריכת הדלק חורגת מ-‎2^53 מיקרוליטר, הערך הזה הוא Number.POSITIVE_INFINITY.
routeRestrictionsPartiallyIgnored
readonly
סוג: boolean optional
יכול להיות שבRoute יש הגבלות שלא מתאימות לאמצעי התחבורה או לשינויים במסלול שביקשת.
speedReadingIntervals
readonly
סוג: Array<SpeedReadingInterval> optional
מרווחי קריאת מהירות שמפרטים את צפיפות התנועה. רלוונטי במקרה של TRAFFIC_AWARE ו-TRAFFIC_AWARE_OPTIMAL ComputeRoutesRequest.routingPreference. המרווחים מכסים את כל הקו הפוליגוני של Route בלי חפיפה. נקודת ההתחלה של מרווח זמן מסוים זהה לנקודת הסיום של מרווח הזמן הקודם.

דוגמה:
 polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
speedReadingIntervals: [A,C), [C,D), [D,G)
tollInfo
readonly
סוג: TollInfo optional
מכיל מידע על אגרות בכביש Route. השדה הזה מאוכלס רק אם צפויים כבישי אגרה בRoute. אם השדה הזה מוגדר אבל השדה TollInfo.estimatedPrices לא מאוכלס, המסלול כולל כבישי אגרה אבל המחיר המשוער לא ידוע. אם השדה הזה ריק, אין כבישי אגרה בRoute.
transitFare
readonly
סוג: Money optional
אם הוא קיים, הוא מכיל את העלות הכוללת של הנסיעה או הכרטיס של Route. המאפיין הזה מוחזר רק עבור TRANSIT ComputeRoutesRequest.travelMode ורק עבור מסלולים שבהם מידע על תעריפים זמין לכל שלבי הנסיעה בתחבורה הציבורית.
בירושה: toJSON

קבועים של RoutingPreference

constants google.maps.routes.RoutingPreference
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג RoutingPreferenceString.

const {RoutingPreference} = await google.maps.importLibrary("routes");
TRAFFIC_AWARE מחשב מסלולים תוך התחשבות במצב התנועה בזמן אמת. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TRAFFIC_AWARE_OPTIMAL חישוב המסלולים תוך התחשבות במצב התנועה בזמן אמת, בלי להחיל את רוב האופטימיזציות של הביצועים. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TRAFFIC_UNAWARE חישוב מסלולים בלי להתחשב במצב התנועה בזמן אמת. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

קבועי מהירות

constants google.maps.routes.Speed
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג SpeedString.

const {Speed} = await google.maps.importLibrary("routes");
NORMAL מהירות רגילה, אין עיכובים בתנועה. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
SLOW זוהתה האטה, עומס תנועה בינוני. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
TRAFFIC_JAM עיכובים בתנועה. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

ממשק SpeedPath

ממשק google.maps.routes.SpeedPath

מקבץ את LatLngAltitude של קטע מסלול עם קריאת המהירות של הקטע.

path
הנתיב שבו נמדדת המהירות.
speed
אופציונלי
סוג: Speed optional
מהירות הנסיעה בנתיב.

המחלקה SpeedReadingInterval

class google.maps.routes.SpeedReadingInterval
library "routes"

אינדיקטור של צפיפות התנועה בקטע רציף של קו פוליגוני או מסלול. במסלול עם הנקודות P_0, ‏ P_1,‏ ... , ‏ P_N (אינדקס מבוסס-אפס), SpeedReadingInterval מתאר את צפיפות התנועה במרווח זמן מסוים.

const {SpeedReadingInterval} = await google.maps.importLibrary("routes");
endPolylinePointIndex
readonly
סוג: number optional
אינדקס הסיום של המרווח הזה בקו הפוליגוני.
speed
readonly
סוג: Speed optional
מהירות התנועה במרווח הזמן הזה.
startPolylinePointIndex
readonly
סוג: number optional
האינדקס ההתחלתי של המרווח הזה בקו הפוליגוני.

StepsOverview class

class google.maps.routes.StepsOverview
library "routes"

סקירה כללית על רשימה של RouteLeg.steps.

const {StepsOverview} = await google.maps.importLibrary("routes");
multiModalSegments
readonly
מידע מסוכם על קטעים מולטי-מודאליים שונים של RouteLeg.steps.
בירושה: toJSON

המחלקה TollInfo

class google.maps.routes.TollInfo
library "routes"

מכיל מידע על אגרה בRoute או בRouteLeg.

const {TollInfo} = await google.maps.importLibrary("routes");
estimatedPrices
readonly
סוג: Array<Money> optional
הסכום הכספי של אגרות הנסיעה בכביש Route או RouteLeg המתאים. הרשימה הזו מכילה סכום לכל מטבע שצפוי להיות מחויב על ידי תחנות אגרה. בדרך כלל הרשימה הזו תכיל רק פריט אחד למסלולים עם אגרות במטבע אחד. בנסיעות בינלאומיות, הרשימה הזו יכולה להכיל כמה פריטים כדי לשקף את אגרות הכביש במטבעות שונים. השדה הזה יכול להיות מערך ריק אם צפויים כבישי אגרה אבל המחיר המשוער לא ידוע.
בירושה: toJSON

מחלקה TransitAgency

class google.maps.routes.TransitAgency
library "routes"

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

const {TransitAgency} = await google.maps.importLibrary("routes");
name
readonly
סוג: string optional
השם של חברת התחבורה הציבורית הזו.
phoneNumber
readonly
סוג: string optional
מספר הטלפון של חברת התחבורה הציבורית, בפורמט שמתאים למיקום הגיאוגרפי.
url
readonly
סוג: URL optional
כתובת ה-URL של חברת התחבורה הציבורית.
בירושה: toJSON

הכיתה TransitDetails

class google.maps.routes.TransitDetails
library "routes"

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

const {TransitDetails} = await google.maps.importLibrary("routes");
arrivalStop
readonly
סוג: TransitStop optional
מידע על תחנת ההגעה של השלב.
arrivalTime
readonly
סוג: Date optional
זמן ההגעה המשוער לשלב.
departureStop
readonly
סוג: TransitStop optional
מידע על תחנת היציאה של השלב.
departureTime
readonly
סוג: Date optional
שעת היציאה המשוערת של השלב.
headsign
readonly
סוג: string optional
מציין את כיוון הנסיעה בקו הזה, כפי שהוא מסומן על הרכב או בתחנת היציאה. הכיוון הוא בדרך כלל התחנה הסופית.
headwayMillis
readonly
סוג: number optional
מציין את הזמן הצפוי באלפיות השנייה בין יציאות מאותה תחנה בשעה הזו. לדוגמה, אם ערך המרווח הוא 600,000, זמן ההמתנה הצפוי אם פספסתם את האוטובוס הוא 10 דקות.

הערה: אם מרווח הזמן בין הנסיעות עולה על 2 בחזקת 53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
stopCount
readonly
סוג: number
מספר התחנות מתחנת המוצא ועד לתחנת היעד. המספר הזה כולל את תחנת ההגעה, אבל לא את תחנת היציאה. לדוגמה, אם המסלול יוצא מתחנה א', עובר דרך תחנות ב' וג' ומגיע לתחנה ד', הערך של stopCount יהיה 3.
transitLine
readonly
סוג: TransitLine optional
מידע על קו התחבורה הציבורית שמשמש בשלב.
tripShortText
readonly
סוג: string optional
הטקסט שמופיע בלוחות הזמנים ובשלטים כדי לזהות נסיעה בתחבורה ציבורית עבור הנוסעים. הטקסט מזהה באופן ייחודי נסיעה ביום שירות. לדוגמה, "538" הוא tripShortText של רכבת Amtrak שיוצאת מסן חוזה, קליפורניה בשעה 15:10 בימי חול לסקרמנטו, קליפורניה.
בירושה: toJSON

מחלקה TransitLine

class google.maps.routes.TransitLine
library "routes"

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

const {TransitLine} = await google.maps.importLibrary("routes");
agencies
readonly
חברת התחבורה הציבורית (או החברות) שמפעילה את קו התחבורה הציבורית הזה.
color
readonly
סוג: string optional
הצבע שמופיע בדרך כלל בשילוט של הקו הזה. מיוצג בבסיס הקסדצימלי.
iconURL
readonly
סוג: URL optional
כתובת ה-URL של הסמל שמשויך לשורה הזו.
name
readonly
סוג: string optional
השם המלא של קו התחבורה הציבורית, לדוגמה, "8 Avenue Local".
shortName
readonly
סוג: string optional
השם המקוצר של קו התחבורה הציבורית הזה. השם הזה יהיה בדרך כלל מספר קו, כמו "M7" או "355".
textColor
readonly
סוג: string optional
הצבע שמופיע בדרך כלל בטקסט בשילוט של הקו הזה. מיוצג בבסיס הקסדצימלי.
url
readonly
סוג: URL optional
כתובת ה-URL של קו התחבורה הציבורית הזה, כפי שסופקה על ידי חברת התחבורה הציבורית.
vehicle
readonly
סוג: TransitVehicle optional
סוג כלי הרכב שפועל בקו התחבורה הציבורית הזה.
בירושה: toJSON

ממשק TransitPreference

ממשק google.maps.routes.TransitPreference

העדפות למסלולים שמבוססים על TRANSIT, שמשפיעות על המסלול שמוחזר.

allowedTransitModes
אופציונלי
סוג: Iterable<TransitMode> optional
קבוצה של אמצעי תחבורה שבהם אפשר להשתמש כשמקבלים מסלול ב-TRANSIT. כברירת מחדל, כל אמצעי ההגעה הנתמכים.
routingPreference
אופציונלי
סוג: TransitRoutePreference optional
העדפת מסלול שמשפיעה על המסלול שמוחזר על ידי TRANSIT, אם היא צוינה.

מחלקה TransitStop

class google.maps.routes.TransitStop
library "routes"

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

const {TransitStop} = await google.maps.importLibrary("routes");
location
readonly
סוג: DirectionalLocation optional
מיקום התחנה, שמיוצג על ידי קואורדינטות של קו רוחב/קו אורך וכיוון (אופציונלי).
name
readonly
סוג: string optional
שם התחנה של התחבורה הציבורית.
בירושה: toJSON

מחלקה TransitVehicle

class google.maps.routes.TransitVehicle
library "routes"

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

const {TransitVehicle} = await google.maps.importLibrary("routes");
iconURL
readonly
סוג: URL optional
כתובת ה-URL של סמל שמשויך לסוג כלי רכב זה.
localIconURL
readonly
סוג: URL optional
כתובת ה-URL של הסמל שמשויך לסוג כלי הרכב הזה, על סמך השילוט של התחבורה המקומית.
name
readonly
סוג: string optional
שם הרכב, באותיות רישיות.
nameLanguage
readonly
סוג: string optional
קוד השפה בתקן BCP-47 של טקסט שם הרכב, למשל "en-US" או "sr-Latn".

מידע נוסף זמין בכתובת: https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
vehicleType
readonly
סוג: string optional
סוג הרכב שבו השתמשתם.

רשימה של ערכים אפשריים זמינה בכתובת https://developers.google.com/maps/documentation/routes/reference/rpc/google.maps.routing.v2#transitvehicletype.
בירושה: toJSON

קבועים של VehicleEmissionType

constants google.maps.routes.VehicleEmissionType
ספרייה "routes"

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

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג VehicleEmissionTypeString.

const {VehicleEmissionType} = await google.maps.importLibrary("routes");
DIESEL רכב שמונע בדיזל. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
ELECTRIC רכב שמופעל באמצעות חשמל. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
GASOLINE רכב שמונע בבנזין. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
HYBRID רכב היברידי (למשל, בנזין וחשמל). מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

ממשק VehicleInfo

ממשק google.maps.routes.VehicleInfo

מכיל את פרטי הרכב, כמו סוג פליטת הרכב.

emissionType
אופציונלי
סוג: VehicleEmissionType optional
מתאר את סוג הפליטות של הרכב. ההגדרה חלה רק על אופן ההתניידות DRIVING.

ממשק Waypoint

ממשק google.maps.routes.Waypoint

מייצג נקודת דרך במסלול.

location
המיקום של ציון הדרך. מחרוזת יכולה להיות כתובת, Plus Code או שם של משאב מקום.
sideOfRoad
אופציונלי
סוג: boolean optional
מציין שהמיקום של נקודת הדרך הזו נועד להעדפה שהרכב יעצור בצד מסוים של הכביש. כשמגדירים את הערך הזה, המסלול יעבור דרך המיקום כך שהרכב יוכל לעצור בצד הכביש שהמיקום נוטה אליו ממרכז הכביש. האפשרות הזו פועלת רק ב-DRIVING וב-TWO_WHEELER ComputeRoutesRequest.travelMode
vehicleStopover
אופציונלי
סוג: boolean optional
מציין שציון הדרך מיועד לעצירת רכבים, במטרה לאסוף או להוריד. כשמגדירים את הערך הזה, המסלול המחושב לא יכלול ציוני דרך שאינם via בכבישים שלא מתאימים לאיסוף ולהורדה. האפשרות הזו פועלת רק עבור DRIVING ו-TWO_WHEELER ComputeRoutesRequest.travelMode וכאשר Waypoint.location אינו string או Place.
via
אופציונלי
סוג: boolean optional
מסמן את נקודת הדרך הזו כאבן דרך ולא כנקודת עצירה. לכל נקודת ציון שאינה via ב-ComputeRoutesRequest, Route.computeRoutes מוסיפה רשומה למערך Route.legs כדי לספק את הפרטים של עצירות הביניים בקטע הזה של הנסיעה.

צריך להגדיר את הערך הזה בתור true אם רוצים שהמסלול יעבור דרך נקודת הדרך הזו בלי לעצור בה. נקודות ציון מסוג Via לא גורמות להוספת רשומה למערך Route.legs, אבל הן מנתבות את הנסיעה דרך נקודת הציון.

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

הממשק WaypointMarkerDetails

ממשק google.maps.routes.WaypointMarkerDetails

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

index
סוג: number
האינדקס של הסמן.
totalMarkers
סוג: number
מספר הסמנים הכולל במסלול.
leg
אופציונלי
סוג: RouteLeg optional
הקטע שאליו שייך הסמן. השדה ריק אם אין מקטעים במסלול.