Shipment Tracking

FleetEngineShipmentLocationProvider class

google.maps.journeySharing.FleetEngineShipmentLocationProvider class

ספק מיקום המשלוח.

הכיתה הזו היא הרחבה של PollingLocationProvider.

אפשר להתקשר אל const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") כדי לקבל גישה.
מידע נוסף זמין במאמר בנושא ספריות ב-Maps JavaScript API.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
פרמטרים: 
יוצר ספק מיקום חדש למעקב משלוחים ב-Fleet Engine.
trackingId
סוג:  string
מזהה המעקב של המשימה שספק המיקום הזה עוקב אחריה. כדי להתחיל לעקוב, צריך להגדיר את השדה הזה.
בירושה: isPolling, pollingIntervalMillis
refresh
refresh()
פרמטרים:  אין
ערך מוחזר:  void
רענון מפורש של המיקום המעקב.
Inherited: addListener
error
function(event)
ארגומנטים: 
אירוע שמופעל כשספק המיקום נתקל בשגיאה.
update
function(event)
ארגומנטים: 
אירוע שמופעל כשבקשה לעדכון נתונים ב-Fleet Engine מסתיימת.
Inherited: ispollingchange

ממשק FleetEngineShipmentLocationProviderOptions

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions ממשק

אפשרויות לספק מיקום המשלוח.

authTokenFetcher
מספק אסימוני אינטרנט מסוג JSON לאימות הלקוח ב-Fleet Engine.
projectId
סוג:  string
מזהה הפרויקט של הלקוח במסוף Google Cloud.
activePolylineCustomization optional
ההתאמה האישית חלה על הקו הפוליגוני הפעיל. קו פוליגוני פעיל תואם לחלק מהמסלול שבו הרכב נוסע כרגע.

בשדה הזה אפשר לציין סגנון מותאם אישית (למשל צבע של קו פוליגון) ואינטראקטיביות (למשל טיפול בקליקים).
  • אם מציינים אובייקט PolylineOptions, השינויים שמצוינים בו יחולו על הקו המרוסק אחרי שהוא ייווצר, ויחליפו את אפשרויות ברירת המחדל שלו אם הן קיימות.
  • אם מציינים פונקציה, היא מופעלת פעם אחת כשהקו המקוטע נוצר. (בפעולה הזו, הפרמטר isNew באובייקט הפרמטרים של הפונקציה מוגדר ל-true). בנוסף, הפונקציה הזו מופעלת כשקואורדינטות הקו המשונן משתנות, או כשספק המיקום מקבל נתונים מ-Fleet Engine, בלי קשר לשאלה אם הנתונים שמתאימים לקו המשונן הזה השתנו.

    במאמר ShipmentPolylineCustomizationFunctionParams מפורטת רשימה של הפרמטרים שסופקו והשימושים שלהם.
deliveryVehicleMarkerCustomization optional
סוג:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
התאמה אישית שחלה על סמן רכב המשלוחים.

בשדה הזה מציינים עיצוב מותאם אישית (כמו סמל של סמן) ואינטראקטיביות (כמו טיפול בקליקים).
  • אם מציינים אובייקט MarkerOptions, השינויים שצוינו בו יחולו על הסמן אחרי שהוא ייווצר, ויחליפו את אפשרויות ברירת המחדל שלו אם הן קיימות.
  • אם מציינים פונקציה, היא מופעלת פעם אחת כשהסמן נוצר, לפני שהוא מתווסף לתצוגת המפה. (בהפעלה הזו, הפרמטר isNew באובייקט הפרמטרים של הפונקציה מוגדר ל-true). בנוסף, הפונקציה הזו מופעלת כשספק המיקום מקבל נתונים מ-Fleet Engine, בלי קשר לשאלה אם הנתונים שמתאימים לסמן הזה השתנו.

    במאמר ShipmentMarkerCustomizationFunctionParams מפורטת רשימה של הפרמטרים שסופקו והשימושים שלהם.
destinationMarkerCustomization optional
סוג:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
ההתאמה האישית חלה על סמן היעד.

בשדה הזה מציינים עיצוב מותאם אישית (כמו סמל של סמן) ואינטראקטיביות (כמו טיפול בקליקים).
  • אם מציינים אובייקט MarkerOptions, השינויים שצוינו בו יחולו על הסמן אחרי שהוא ייווצר, ויחליפו את אפשרויות ברירת המחדל שלו אם הן קיימות.
  • אם מציינים פונקציה, היא מופעלת פעם אחת כשהסמן נוצר, לפני שהוא מתווסף לתצוגת המפה. (בהפעלה הזו, הפרמטר isNew באובייקט הפרמטרים של הפונקציה מוגדר ל-true). בנוסף, הפונקציה הזו מופעלת כשספק המיקום מקבל נתונים מ-Fleet Engine, בלי קשר לשאלה אם הנתונים שמתאימים לסמן הזה השתנו.

    במאמר ShipmentMarkerCustomizationFunctionParams מפורטת רשימה של הפרמטרים שסופקו והשימושים שלהם.
pollingIntervalMillis optional
סוג:  number optional
פרק הזמן המינימלי בין אחזור עדכוני מיקום באלפיות השנייה. אם חולף יותר מ-pollingIntervalMillis עד שהמיקום מתעדכן, העדכון הבא של המיקום לא יתחיל עד שהעדכון הנוכחי יסתיים.

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

הערך שמוגדר כברירת מחדל, והערך המינימלי, של מרווח הזמן בין בדיקות הוא 5,000 אלפיות השנייה. אם מגדירים את מרווח הזמן של הבדיקה לערך חיובי נמוך יותר, המערכת מאחסנת את הערך 5,000 ומשתמשת בו.
remainingPolylineCustomization optional
ההתאמה האישית חלה על הקו המרובה הנותר. קו פוליגוני שנותר תואם לחלק מהמסלול שהרכב עדיין לא התחיל לנוע בו.

בשדה הזה אפשר לציין סגנון מותאם אישית (למשל צבע של קו פוליגון) ואינטראקטיביות (למשל טיפול בקליקים).
  • אם מציינים אובייקט PolylineOptions, השינויים שמצוינים בו יחולו על הקו המרוסק אחרי שהוא ייווצר, ויחליפו את אפשרויות ברירת המחדל שלו אם הן קיימות.
  • אם מציינים פונקציה, היא מופעלת פעם אחת כשהקו המקוטע נוצר. (בפעולה הזו, הפרמטר isNew באובייקט הפרמטרים של הפונקציה מוגדר ל-true). בנוסף, הפונקציה הזו מופעלת כשקואורדינטות הקו המשונן משתנות, או כשספק המיקום מקבל נתונים מ-Fleet Engine, בלי קשר לשאלה אם הנתונים שמתאימים לקו המשונן הזה השתנו.

    במאמר ShipmentPolylineCustomizationFunctionParams מפורטת רשימה של הפרמטרים שסופקו והשימושים שלהם.
takenPolylineCustomization optional
ההתאמה האישית חלה על קו הפוליגון שנוצר. קו פוליגוני שנלקח מתאים לחלק מהמסלול שהרכב כבר עבר.

בשדה הזה אפשר לציין סגנון מותאם אישית (למשל צבע של קו פוליגון) ואינטראקטיביות (למשל טיפול בקליקים).
  • אם מציינים אובייקט PolylineOptions, השינויים שמצוינים בו יחולו על הקו המרוסק אחרי שהוא ייווצר, ויחליפו את אפשרויות ברירת המחדל שלו אם הן קיימות.
  • אם מציינים פונקציה, היא מופעלת פעם אחת כשהקו המקוטע נוצר. (בפעולה הזו, הפרמטר isNew באובייקט הפרמטרים של הפונקציה מוגדר ל-true). בנוסף, הפונקציה הזו מופעלת כשקואורדינטות הקו המשונן משתנות, או כשספק המיקום מקבל נתונים מ-Fleet Engine, בלי קשר לשאלה אם הנתונים שמתאימים לקו המשונן הזה השתנו.

    במאמר ShipmentPolylineCustomizationFunctionParams מפורטת רשימה של הפרמטרים שסופקו והשימושים שלהם.
trackingId optional
סוג:  string optional
מזהה המעקב של המשימה למעקב מיד אחרי יצירת מופע של ספק המיקום. אם לא מציינים את ספק המיקום, הוא לא מתחיל לעקוב אחרי אף משימה. צריך להשתמש ב-FleetEngineShipmentLocationProvider.trackingId כדי להגדיר את מזהה המעקב ולהתחיל לעקוב.

FleetEngineShipmentLocationProviderUpdateEvent interface

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent ממשק

אובייקט האירוע שמועבר ל-event handler כשמופעל האירוע FleetEngineShipmentLocationProvider.update.

taskTrackingInfo optional
סוג:  TaskTrackingInfo optional
המבנה של פרטי המעקב של המשימה שמוחזרים בעקבות העדכון. אי אפשר לשנות.