Shipment Tracking

FleetEngineShipmentLocationProvider-Klasse

google.maps.journeySharing.FleetEngineShipmentLocationProvider Klasse

Anbieter des Versandorts.

Diese Klasse erweitert PollingLocationProvider.

Zugriff über const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") aufrufen. Weitere Informationen finden Sie unter Bibliotheken in der Maps JavaScript API.
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Parameter:
Erstellt einen neuen Standortanbieter für die Fleet Engine-Sendungsverfolgung.
trackingId
Typ:string
Die Tracking-ID für die Aufgabe, die dieser Standortanbieter beobachtet. Legen Sie dieses Feld fest, um mit dem Tracking zu beginnen.
Übernommen: isPolling, pollingIntervalMillis
refresh
refresh()
Parameter:Keine
Rückgabewert:  void
Aktualisiert den beobachteten Standort explizit.
Übernommen: addListener
error
function(event)
Argumente: 
Ereignis, das ausgelöst wird, wenn beim Standortanbieter ein Fehler auftritt.
update
function(event)
Argumente: 
Ereignis, das ausgelöst wird, wenn eine Anfrage zur Aktualisierung von Fleet Engine-Daten abgeschlossen ist.
Übernommen: ispollingchange

FleetEngineShipmentLocationProviderOptions-Schnittstelle

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions-Schnittstelle

Optionen für den Anbieter des Versandorts.
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.
deliveryVehicleMarkerCustomization optional
Die Anpassung wurde auf die Markierung des Lieferfahrzeugs angewendet.

Über dieses Feld können Sie benutzerdefinierte Stile (z. B. Markierungssymbol) und Interaktivität festlegen (z. B. Umgang mit Klicks).
  • Wenn ein MarkerOptions-Objekt angegeben wird, werden die darin angegebenen Änderungen auf die Markierung angewendet, nachdem die Markierung erstellt wurde. Dabei werden die Standardoptionen überschrieben, sofern vorhanden.
  • Ist eine Funktion angegeben, wird sie einmal beim Erstellen der Markierung aufgerufen, bevor sie der Kartenansicht hinzugefügt wird. Bei diesem Aufruf ist der Parameter isNew im Funktionsparameterobjekt auf true gesetzt. 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.

    Eine Liste der bereitgestellten Parameter und ihrer Verwendung finden Sie unter ShipmentMarkerCustomizationFunctionParams.
destinationMarkerCustomization optional
Die Anpassung wurde auf die Zielmarkierung angewendet.

Über dieses Feld können Sie benutzerdefinierte Stile (z. B. Markierungssymbol) und Interaktivität festlegen (z. B. Umgang mit Klicks).
  • Wenn ein MarkerOptions-Objekt angegeben wird, werden die darin angegebenen Änderungen auf die Markierung angewendet, nachdem die Markierung erstellt wurde. Dabei werden die Standardoptionen überschrieben, sofern vorhanden.
  • Ist eine Funktion angegeben, wird sie einmal beim Erstellen der Markierung aufgerufen, bevor sie der Kartenansicht hinzugefügt wird. Bei diesem Aufruf ist der Parameter isNew im Funktionsparameterobjekt auf true gesetzt. 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.

    Eine Liste der bereitgestellten Parameter und ihrer Verwendung finden Sie unter ShipmentMarkerCustomizationFunctionParams.
pollingIntervalMillis optional
Typ:number optional
Die Mindestzeitspanne zwischen dem Abrufen von Standortaktualisierungen in Millisekunden. Wenn das Abrufen eines Standortupdates länger als pollingIntervalMillis dauert, wird die nächste Standortaktualisierung erst gestartet, wenn die aktuelle abgeschlossen ist.

Wenn Sie diesen Wert auf 0, einen unendlichen Wert oder einen negativen Wert festlegen, werden automatische Standortupdates deaktiviert. Ein neues Standortupdate wird einmal abgerufen, wenn sich der Parameter für die Tracking-ID (z. B. die Sendungsverfolgungs-ID des Versandortanbieters) oder eine Filteroption (z. B. Grenzen des Darstellungsbereichs oder Attributfilter für Flottenstandortanbieter) ändert.

Das standardmäßige und minimale Abfrageintervall beträgt 5.000 Millisekunden. Wenn Sie das Abfrageintervall auf einen niedrigeren positiven Wert einstellen, wird 5.000 gespeichert und verwendet.
trackingId optional
Typ:string optional
Die Tracking-ID der Aufgabe, die sofort nach der Instanziierung des Standortanbieters erfasst werden soll. Falls nicht angegeben, beginnt der Standortanbieter mit dem Tracking einer Aufgabe nicht. Verwenden Sie FleetEngineShipmentLocationProvider.trackingId, um die Tracking-ID festzulegen und mit dem Tracking zu beginnen.

FleetEngineShipmentLocationProviderUpdateEvent-Schnittstelle

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent-Schnittstelle

Das Ereignisobjekt, das an den Event-Handler übergeben wird, wenn das FleetEngineShipmentLocationProvider.update-Ereignis ausgelöst wird.
taskTrackingInfo optional
Typ:TaskTrackingInfo optional
Die vom Update zurückgegebene Informationsstruktur für die Aufgabenverfolgung. Nicht änderbar.