Shipment Tracking

Classe FleetEngineShipmentLocationProvider

google.maps.journeySharing.FleetEngineShipmentLocationProvider class
extends PollingLocationProvider
library "journeySharing"

Fournisseur de localisation de l'envoi.

const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Paramètres :
Crée un fournisseur de localisation pour le suivi des envois Fleet Engine.
trackingId
Type : string
ID de suivi de la tâche observée par ce fournisseur de localisation. Définissez ce champ pour commencer le suivi.
Hérité : isPolling, pollingIntervalMillis
refresh
refresh()
Paramètres : aucun
Valeur renvoyée : void
Actualise explicitement l'emplacement suivi.
Hérité : addListener
error
function(event)
Arguments :
Événement déclenché lorsque le fournisseur de localisation rencontre une erreur.
update
function(event)
Événement déclenché lorsqu'une requête de mise à jour des données Fleet Engine est terminée.
Hérité : ispollingchange

Interface FleetEngineShipmentLocationProviderOptions

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions interface

Options pour le fournisseur de l'emplacement de l'envoi.

authTokenFetcher
Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine.
projectId
Type : string
ID du projet du client dans la console Google Cloud.
activePolylineCustomization
facultatif
Personnalisation appliquée à la polyligne active. Une polyligne active correspond à une partie de l'itinéraire que le véhicule est en train de parcourir.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et leurs utilisations.
deliveryVehicleMarkerCustomization
facultatif
Type : (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère du véhicule de livraison.

Utilisez ce champ pour spécifier un style personnalisé (comme l'icône du repère) et l'interactivité (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qu'il contient sont appliquées au repère après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création du repère, avant qu'il ne soit ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à ce repère aient changé ou non.

    Consultez ShipmentMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et leurs utilisations.
destinationMarkerCustomization
facultatif
Type : (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère de destination.

Utilisez ce champ pour spécifier un style personnalisé (comme l'icône du repère) et l'interactivité (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qu'il contient sont appliquées au repère après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création du repère, avant qu'il ne soit ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à ce repère aient changé ou non.

    Consultez ShipmentMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et leurs utilisations.
pollingIntervalMillis
facultatif
Type : number optional
Intervalle de temps minimal entre les récupérations des mises à jour de position, en millisecondes. Si la récupération d'une mise à jour de la position prend plus de pollingIntervalMillis, la mise à jour suivante ne démarre pas tant que la mise à jour actuelle n'est pas terminée.

Si vous définissez cette valeur sur 0, Infinity ou une valeur négative, les mises à jour automatiques de la position sont désactivées. Une nouvelle notification de position est récupérée une fois si le paramètre d'ID de suivi (par exemple, l'ID de suivi de l'envoi du fournisseur de localisation de l'envoi) ou une option de filtrage (par exemple, les limites de la fenêtre d'affichage ou les filtres d'attributs pour les fournisseurs de localisation de la flotte) change.

L'intervalle d'interrogation par défaut et minimal est de 5 000 millisecondes. Si vous définissez l'intervalle d'interrogation sur une valeur positive inférieure, la valeur 5000 est stockée et utilisée.
remainingPolylineCustomization
facultatif
Personnalisation appliquée à la polyligne restante. Une polyligne restante correspond à une partie de l'itinéraire que le véhicule n'a pas encore commencé à parcourir.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et leurs utilisations.
takenPolylineCustomization
facultatif
Personnalisation appliquée à la polyligne empruntée. Une polyligne empruntée correspond à une partie de l'itinéraire que le véhicule a déjà parcourue.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et leurs utilisations.
trackingId
facultatif
Type : string optional
ID de suivi de la tâche à suivre immédiatement après l'instanciation du fournisseur de localisation. Si aucun ID n'est spécifié, le fournisseur de localisation ne commence à suivre aucune tâche. Utilisez FleetEngineShipmentLocationProvider.trackingId pour définir l'ID de suivi et commencer le suivi.

Interface FleetEngineShipmentLocationProviderUpdateEvent

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent interface

Objet d'événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineShipmentLocationProvider.update est déclenché.

taskTrackingInfo
facultatif
Type : TaskTrackingInfo optional
Structure des informations de suivi des tâches renvoyée par la mise à jour. Non modifiable.