Route Matrix

המחלקה RouteMatrix

class google.maps.routes.RouteMatrix
library "routes"

מטריצה של מסלולים שחושבו לקבוצה של צמדי מוצא/יעד על ידי RouteMatrix.computeRouteMatrix

const {RouteMatrix} = await google.maps.importLibrary("routes");
computeRouteMatrix
computeRouteMatrix(request)
פרמטרים:
ערך מוחזר: Promise<{matrix:RouteMatrix}>
מקבלת רשימה של נקודות מוצא ויעדים ומחזירה מטריצה שמכילה מידע על המסלול לכל שילוב של נקודת מוצא ויעד.

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

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

לא מומלץ להשתמש באנונימיזציה של שדות בתגובה עם תו כללי לחיפוש fields: ['*'] כי:
  • אם תבחרו רק את השדות שאתם צריכים, השרת שלנו יחסוך מחזורי חישוב, וכך נוכל להחזיר לכם את התוצאה עם זמן אחזור קצר יותר.
  • כדי להבטיח ביצועי זמן אחזור יציבים, בחרו רק את השדות שאתם צריכים במשימת הייצור. יכול להיות שנוסיף עוד שדות תגובה בעתיד, והשדות החדשים האלה עשויים לדרוש זמן חישוב נוסף. אם תבחרו את כל השדות, או את כל השדות ברמה העליונה, יכול להיות שתהיה ירידה בביצועים כי כל שדה חדש שנוסיף ייכלל באופן אוטומטי בתגובה.
  • אם תבחרו רק את השדות שאתם צריכים, התגובה תהיה קטנה יותר, ולכן היא תיטען מהר יותר ברשת.
rows
readonly
השורות של המטריצה. כל שורה תואמת לנקודת מוצא ומכילה מערך של RouteMatrixItem, שכל אחד מהם מייצג מסלול ליעד.
בירושה: toJSON

הכיתה RouteMatrixRow

class google.maps.routes.RouteMatrixRow
library "routes"

תואם למקור שמועבר אל RouteMatrix.computeRouteMatrix. מכיל רשימה של RouteMatrixItem, כשכל פריט מייצג מסלול ליעד.

const {RouteMatrixRow} = await google.maps.importLibrary("routes");
items
readonly
פרטי המסלול לכל יעד.
בירושה: toJSON

המחלקה RouteMatrixItem

class google.maps.routes.RouteMatrixItem
library "routes"

מכיל מידע על מסלול שחושב עבור צמד של נקודת מוצא/יעד שהועבר אל RouteMatrix.computeRouteMatrix.

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

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
error
readonly
סוג: RouteMatrixItemError optional
שגיאה שהתרחשה במהלך חישוב המסלול.
fallbackInfo
readonly
סוג: FallbackInfo optional
במקרים מסוימים, כשהשרת לא יכול לחשב את המסלול עם ההעדפות שצוינו לצמד הספציפי הזה של נקודת המוצא והיעד, הוא עשוי לחזור להשתמש במצב חישוב אחר. כשמשתמשים ב-fallback, השדה הזה מכיל מידע מפורט על התגובה של ה-fallback. אחרת, השדה הזה לא מוגדר.
localizedValues
readonly
ייצוגים בטקסט של מאפייני RouteMatrixItem.
staticDurationMillis
readonly
סוג: number optional
משך הנסיעה במסלול בלי להביא בחשבון את מצב התנועה.

הערה: אם משך הזמן חורג מ-‎2^53 אלפיות השנייה, הערך הזה הוא Number.POSITIVE_INFINITY.
travelAdvisory
readonly
סוג: RouteTravelAdvisory optional
מידע נוסף על המסלול.

ממשק ComputeRouteMatrixRequest

ממשק google.maps.routes.ComputeRouteMatrixRequest

בקשה למטריצת מסלולים.

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

יש כמה מגבלות גודל שחלות על העוצמה (cardinality) של נקודות המוצא והיעדים:
  • המספר הכולל של נקודות המוצא והיעדים שצוינו כ-string או כ-Place לא יכול להיות גדול מ-50.
  • המכפלה של מספר נקודות המוצא ומספר היעדים לא יכולה להיות גדולה מ-625.
  • המכפלה של מספר נקודות המוצא והיעדים לא יכולה להיות גדולה מ-100 אם ComputeRouteMatrixRequest.routingPreference מוגדר ל-TRAFFIC_AWARE_OPTIMAL.
  • המכפלה של מספר נקודות המוצא והיעדים לא יכולה להיות גדולה מ-100 אם ComputeRouteMatrixRequest.travelMode מוגדר ל-TRANSIT.
arrivalTime
אופציונלי
סוג: Date optional
זמן ההגעה.

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

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

הערה: החישובים הנוספים האלה עשויים להחזיר שדות נוספים בתגובה. כדי שהשדות הנוספים האלה יוחזרו בתגובה, צריך לציין אותם גם ב-ComputeRouteMatrixRequest.fields.
internalUsageAttributionIds
אופציונלי
סוג: Iterable<string> optional
מזהים שמשמשים לשיוך קריאות לחבילות ספציפיות או לספריות OSS.
language
אופציונלי
סוג: string optional
קוד השפה בתקן BCP-47, למשל "en-US" או "sr-Latn". מידע נוסף זמין במאמר מזהה לוקאל של Unicode. כאן מפורטות השפות שבהן אפשר לקבל תמיכה. אם לא תציינו את הערך הזה, השפה תוסק מהגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, השפה נקבעת לפי המיקום של המקור הראשון.
region
אופציונלי
סוג: string optional
קוד האזור, שמוגדר כערך ccTLD (דומיין ברמה העליונה) באורך שני תווים. מידע נוסף זמין במאמר דומיינים ברמה העליונה עם קוד מדינה (ccTLD). אם לא תספקו את הערך הזה, האזור יוסק מהגדרות הלוקליזציה של Google Maps JavaScript API. אחרת, האזור נקבע לפי המיקום של המקור הראשון.
routingPreference
אופציונלי
סוג: RoutingPreference optional
מציין איך לחשב את מטריצת המסלולים. השרת מנסה להשתמש בהעדפת המסלול שנבחרה כדי לחשב את מטריצת המסלולים. אם העדפת הניתוב גורמת לשגיאה או לזמן אחזור ארוך במיוחד, תוחזר שגיאה. אפשר לציין את האפשרות הזו רק כשהערך של ComputeRouteMatrixRequest.travelMode הוא DRIVING או TWO_WHEELER, אחרת הבקשה תיכשל.
trafficModel
אופציונלי
סוג: TrafficModel optional
מציין את ההנחות שצריך להשתמש בהן כשמחשבים את הזמן בתנועה. ההגדרה הזו משפיעה על הערך שמוחזר ב-RouteMatrixItem.durationMillis, שמכיל את הזמן החזוי בתנועה על סמך ממוצעים היסטוריים. השדה ComputeRouteMatrixRequest.trafficModel זמין רק לבקשות שבהן השדה ComputeRouteMatrixRequest.routingPreference מוגדר כ-TRAFFIC_AWARE_OPTIMAL והשדה ComputeRouteMatrixRequest.travelMode מוגדר כ-DRIVING. ברירת המחדל היא BEST_GUESS.
transitPreference
אופציונלי
סוג: TransitPreference optional
מציינת העדפות שמשפיעות על המסלול שמוחזר למסלולי TRANSIT.

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

קבועים של ComputeRouteMatrixExtraComputation

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

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

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

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

קבועים של RouteMatrixItemCondition

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

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

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

const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes");
ROUTE_EXISTS נמצא מסלול, והמידע התואם מולא בשביל הרכיב. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.
ROUTE_NOT_FOUND לא נמצא מסלול. מידע נוסף זמין במסמכי התיעוד של שירות האינטרנט.

מחלקה RouteMatrixItemError

class google.maps.routes.RouteMatrixItemError extends Error
library "routes"

שגיאה שאירעה במהלך RouteMatrix.computeRouteMatrix עבור צמד ספציפי של מקור/יעד.

const {RouteMatrixItemError} = await google.maps.importLibrary("routes");
בירושה: toJSON

המחלקה RouteMatrixItemLocalizedValues

class google.maps.routes.RouteMatrixItemLocalizedValues
library "routes"

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

const {RouteMatrixItemLocalizedValues} = 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
משך הזמן, מיוצג בפורמט טקסט ומותאם לאזור של השאילתה. לוקח בחשבון את מצב התנועה.

הערה: אם לא ביקשתם מידע על התנועה, הערך הזה זהה לערך של RouteMatrixItemLocalizedValues.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".

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

ממשק RouteMatrixOrigin

ממשק google.maps.routes.RouteMatrixOrigin

מקור אחד ל-ComputeRouteMatrixRequest.

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