Shipment Tracking

המחלקה FleetEngineShipmentLocationProvider

מחלקה google.maps.journeySharing.FleetEngineShipmentLocationProvider

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

המחלקה הזו מרחיבה את PollingLocationProvider.

כדי לקבל גישה, צריך לקרוא ל: const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing").
מידע נוסף מופיע בדף ספריות ב-Maps JavaScript API.
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
פרמטרים: 
יוצר ספק מיקום חדש למעקב משלוחים ב-Fleet Engine.
trackingId
סוג:  string
מזהה המעקב של המשימה שספק המיקום הזה עוקב אחריה. כדי להתחיל לעקוב, צריך להגדיר את השדה הזה.
בירושה: isPolling, pollingIntervalMillis
refresh
refresh()
פרמטרים:  אין
ערך מוחזר:  void
רענון מפורש של המיקום שבמעקב.
בירושה: addListener
error
function(event)
ארגומנטים: 
אירוע שמופעל כשספק המיקום נתקל בשגיאה.
update
function(event)
ארגומנטים: 
אירוע שמופעל כשבקשה לעדכון של נתוני Fleet Engine מסתיימת.
בירושה: 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

ממשק google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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