Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Fournisseur de l'adresse de livraison.

Cette classe étend PollingLocationProvider.

Pour y accéder, appelez const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing"). Consultez Bibliothèques dans l'API Maps JavaScript.

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Paramètres: 
Crée un fournisseur d'emplacements pour le suivi des livraisons 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'établissement suivi.
Hérité: addListener
error
function(event)
Arguments: 
Événement déclenché lorsqu'une erreur est rencontrée par le fournisseur de services de localisation.
update
function(event)
Événement déclenché lorsqu'une requête de mise à jour de données Fleet Engine est terminée.
Hérité: ispollingchange

Interface FleetEngineShipmentLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Options pour le fournisseur de localisation de livraison.

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

Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qui y sont spécifiées sont appliquées à la polyligne après sa création, en remplaçant ses options par défaut, le cas échéant.
  • 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 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 leur utilisation.
deliveryVehicleMarkerCustomization optional
Personnalisation appliquée au repère du véhicule de livraison.

Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qui y sont spécifiées sont appliquées au repère une fois celui-ci créé, remplaçant 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'elle ne soit ajoutée à la vue plan. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de services 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 leur utilisation.
destinationMarkerCustomization optional
Personnalisation appliquée au repère de la destination.

Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qui y sont spécifiées sont appliquées au repère une fois celui-ci créé, remplaçant 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'elle ne soit ajoutée à la vue plan. (Lors de cet appel, le paramètre isNew de l'objet de paramètres de fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de services 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 leur utilisation.
pollingIntervalMillis optional
Type:number optional
Délai minimal entre la récupération des mises à jour de la position (en millisecondes). Si la récupération d'une mise à jour de la position prend plus de pollingIntervalMillis, la mise à jour suivante n'est lancée que lorsque la mise à jour en cours est terminée.

Si vous définissez cette valeur sur 0, sur "infini" ou sur une valeur négative, la mise à jour automatique de la position sera désactivée. Une nouvelle mise à jour de la position est récupérée une fois si le paramètre d'ID de suivi (par exemple, l'ID de suivi de la livraison du fournisseur de localisation de la livraison) ou une option de filtrage (par exemple, les limites de la fenêtre d'affichage ou les filtres d'attributs pour les fournisseurs de services de localisation de parc) est modifié.

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 5 000 est stockée et utilisée.
remainingPolylineCustomization optional
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é à traverser.

Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qui y sont spécifiées sont appliquées à la polyligne après sa création, en remplaçant ses options par défaut, le cas échéant.
  • 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 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 leur utilisation.
takenPolylineCustomization optional
Personnalisation appliquée à la polyligne choisie. Une polyligne utilisée correspond à une partie de l'itinéraire que le véhicule a déjà traversé.

Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qui y sont spécifiées sont appliquées à la polyligne après sa création, en remplaçant ses options par défaut, le cas échéant.
  • 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 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 leur utilisation.
trackingId optional
Type:string optional
ID de suivi de la tâche à suivre immédiatement après l'instanciation du fournisseur de localisation. S'il n'est pas spécifié, le fournisseur de localisation ne lance le suivi d'aucune tâche. Utilisez FleetEngineShipmentLocationProvider.trackingId pour définir l'ID de suivi et commencer le suivi.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

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

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