Shipment Tracking

FleetEngineShipmentLocationProvider-Klasse

google.maps.journeySharing.FleetEngineShipmentLocationProvider Klasse

Anbieter des Versandorts.

Diese Klasse erweitert PollingLocationProvider.

Zugriff durch Anrufen von const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing").
Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parameter:
Erstellt einen neuen Standortanbieter für das Sendungsverfolgungs-Feature von Fleet Engine.
trackingId
Typ:string
Die Tracking-ID für die Aufgabe, die von diesem Standortanbieter beobachtet wird. Legen Sie dieses Feld fest, um mit dem Tracking zu beginnen.
Übernommen:isPolling, pollingIntervalMillis
refresh
refresh()
Parameter:Keine
Rückgabewert:void
Aktualisiert den verfolgten Standort explizit.
Übernommen:addListener
error
function(event)
Argumente: 
Ereignis, das ausgelöst wird, wenn beim Standortanbieter ein Fehler auftritt.
update
function(event)
Ereignis, das ausgelöst wird, wenn eine Fleet Engine-Datenaktualisierungsanfrage abgeschlossen ist.
Übernommen:ispollingchange

FleetEngineShipmentLocationProviderOptions-Schnittstelle

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions-Schnittstelle

Optionen für den Anbieter des Versandstandorts.

authTokenFetcher
Stellt JSON-Webtokens zur Authentifizierung des Clients bei Fleet Engine bereit.
projectId
Typ:string
Die Projekt-ID des Nutzers aus der Google Cloud Console.
activePolylineCustomization optional
Auf die aktive Polylinie angewendete Anpassung. Eine aktive Polylinie entspricht einem Teil der Route, die das Fahrzeug gerade durchfährt.

Mit diesem Feld können Sie benutzerdefinierte Formatierungen (z. B. die Farbe von Polylinien) und Interaktivität (z. B. die Verarbeitung von Klicks) angeben.
  • Wenn ein PolylineOptions-Objekt angegeben ist, werden die darin angegebenen Änderungen auf die Polylinie angewendet, nachdem sie erstellt wurde. Dabei werden die Standardoptionen der Polylinie überschrieben, sofern sie vorhanden sind.
  • Wenn eine Funktion angegeben ist, wird sie einmal aufgerufen, wenn die Polylinie erstellt wird. Bei diesem Aufruf wird der Parameter isNew im Objekt der Funktionsparameter auf true gesetzt. Außerdem wird diese Funktion aufgerufen, wenn sich die Koordinaten der Polylinie ändern oder wenn der Standortanbieter Daten von Fleet Engine empfängt, unabhängig davon, ob sich die Daten für diese Polylinie geändert haben.

    Eine Liste der bereitgestellten Parameter und ihrer Verwendung finden Sie unter ShipmentPolylineCustomizationFunctionParams.
deliveryVehicleMarkerCustomization optional
Anpassung der Markierung für das Lieferfahrzeug.

Mit diesem Feld können Sie benutzerdefinierte Formatierungen (z. B. Markersymbol) und Interaktivität (z. B. Klickbehandlung) angeben.
  • Wenn ein MarkerOptions-Objekt angegeben ist, werden die darin angegebenen Änderungen auf die Markierung angewendet, nachdem sie erstellt wurde. Dabei werden die Standardoptionen der Markierung überschrieben, sofern sie vorhanden sind.
  • Wenn eine Funktion angegeben ist, wird sie einmal aufgerufen, wenn die Markierung erstellt wird, bevor sie der Kartenansicht hinzugefügt wird. Bei diesem Aufruf wird der Parameter isNew im Funktionsparameterobjekt auf true festgelegt. Außerdem wird diese Funktion aufgerufen, wenn der Standortanbieter Daten von Fleet Engine empfängt, unabhängig davon, ob sich die Daten für diese Markierung geändert haben.

    Unter ShipmentMarkerCustomizationFunctionParams finden Sie eine Liste der bereitgestellten Parameter und ihrer Verwendung.
destinationMarkerCustomization optional
Auf die Zielmarkierung angewendete Anpassung.

Mit diesem Feld können Sie benutzerdefinierte Formatierungen (z. B. Markersymbol) und Interaktivität (z. B. Klickbehandlung) angeben.
  • Wenn ein MarkerOptions-Objekt angegeben ist, werden die darin angegebenen Änderungen auf die Markierung angewendet, nachdem sie erstellt wurde. Dabei werden die Standardoptionen der Markierung überschrieben, sofern sie vorhanden sind.
  • Wenn eine Funktion angegeben ist, wird sie einmal aufgerufen, wenn die Markierung erstellt wird, bevor sie der Kartenansicht hinzugefügt wird. Bei diesem Aufruf wird der Parameter isNew im Funktionsparameterobjekt auf true festgelegt. Außerdem wird diese Funktion aufgerufen, wenn der Standortanbieter Daten von Fleet Engine empfängt, unabhängig davon, ob sich die Daten für diese Markierung geändert haben.

    Unter ShipmentMarkerCustomizationFunctionParams finden Sie eine Liste der bereitgestellten Parameter und ihrer Verwendung.
pollingIntervalMillis optional
Typ:number optional
Mindestzeit zwischen dem Abrufen von Standortaktualisierungen in Millisekunden. Wenn es länger als pollingIntervalMillis dauert, bis eine Standortaktualisierung abgerufen wird, wird die nächste Standortaktualisierung erst gestartet, wenn die aktuelle abgeschlossen ist.

Wenn Sie diesen Wert auf 0, „Infinity“ oder einen negativen Wert setzen, werden automatische Standortaktualisierungen deaktiviert. Eine neue Standortaktualisierung wird einmal abgerufen, wenn sich der Parameter für die Tracking-ID (z. B. die Tracking-ID des Versandstandortanbieters) oder eine Filteroption (z. B. die Grenzen des Darstellungsbereichs oder Attributfilter für Flottenstandortanbieter) ändert.

Das Standard- und Mindest-Polling-Intervall beträgt 5.000 Millisekunden. Wenn Sie das Abfrageintervall auf einen niedrigeren positiven Wert festlegen, wird 5.000 gespeichert und verwendet.
remainingPolylineCustomization optional
Die Anpassung wird auf die verbleibende Polylinie angewendet. Eine verbleibende Polylinie entspricht einem Teil der Route, den das Fahrzeug noch nicht befahren hat.

Mit diesem Feld können Sie benutzerdefinierte Formatierungen (z. B. die Farbe von Polylinien) und Interaktivität (z. B. die Verarbeitung von Klicks) angeben.
  • Wenn ein PolylineOptions-Objekt angegeben ist, werden die darin angegebenen Änderungen auf die Polylinie angewendet, nachdem sie erstellt wurde. Dabei werden die Standardoptionen der Polylinie überschrieben, sofern sie vorhanden sind.
  • Wenn eine Funktion angegeben ist, wird sie einmal aufgerufen, wenn die Polylinie erstellt wird. Bei diesem Aufruf wird der Parameter isNew im Objekt der Funktionsparameter auf true gesetzt. Außerdem wird diese Funktion aufgerufen, wenn sich die Koordinaten der Polylinie ändern oder wenn der Standortanbieter Daten von Fleet Engine empfängt, unabhängig davon, ob sich die Daten für diese Polylinie geändert haben.

    Eine Liste der bereitgestellten Parameter und ihrer Verwendung finden Sie unter ShipmentPolylineCustomizationFunctionParams.
takenPolylineCustomization optional
Auf die aufgenommene Polylinie angewendete Anpassung. Eine gefahrene Polylinie entspricht einem Teil der Route, den das Fahrzeug bereits zurückgelegt hat.

Mit diesem Feld können Sie benutzerdefinierte Formatierungen (z. B. die Farbe von Polylinien) und Interaktivität (z. B. die Verarbeitung von Klicks) angeben.
  • Wenn ein PolylineOptions-Objekt angegeben ist, werden die darin angegebenen Änderungen auf die Polylinie angewendet, nachdem sie erstellt wurde. Dabei werden die Standardoptionen der Polylinie überschrieben, sofern sie vorhanden sind.
  • Wenn eine Funktion angegeben ist, wird sie einmal aufgerufen, wenn die Polylinie erstellt wird. Bei diesem Aufruf wird der Parameter isNew im Objekt der Funktionsparameter auf true gesetzt. Außerdem wird diese Funktion aufgerufen, wenn sich die Koordinaten der Polylinie ändern oder wenn der Standortanbieter Daten von Fleet Engine empfängt, unabhängig davon, ob sich die Daten für diese Polylinie geändert haben.

    Eine Liste der bereitgestellten Parameter und ihrer Verwendung finden Sie unter ShipmentPolylineCustomizationFunctionParams.
trackingId optional
Typ:string optional
Die Tracking-ID der Aufgabe, die unmittelbar nach der Instanziierung des Standortanbieters verfolgt werden soll. Wenn nicht angegeben, beginnt der Standortanbieter nicht mit der Erfassung von Aufgaben. Verwenden Sie FleetEngineShipmentLocationProvider.trackingId, um die Tracking-ID festzulegen und mit der Erfassung zu beginnen.

FleetEngineShipmentLocationProviderUpdateEvent-Schnittstelle

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent-Schnittstelle

Das Ereignisobjekt, das an den Ereignis-Handler übergeben wird, wenn das FleetEngineShipmentLocationProvider.update-Ereignis ausgelöst wird.

taskTrackingInfo optional
Typ:TaskTrackingInfo optional
Die von der Aktualisierung zurückgegebene Struktur mit Informationen zur Aufgabenverfolgung. Nicht änderbar.