Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Fournisseur de l'emplacement de l'envoi.

Cette classe étend PollingLocationProvider.

Accédez-y en appelant const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing"). Consultez la section Bibliothèques de l'API Maps JavaScript.
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Paramètres:
Crée un fournisseur de position pour le suivi des envois Fleet Engine.
trackingId
Type:string
ID de suivi de la tâche que ce fournisseur de position observe. 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 position rencontre une erreur.
update
function(event)
Arguments: 
Événement déclenché une fois qu'une requête de mise à jour des données de Fleet Engine est terminée.
Hérité: ispollingchange

Interface FleetEngineShipmentLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Options pour le fournisseur d'emplacement d'expédition.
authTokenFetcher
Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine.
projectId
Type:string
ID de projet du client à partir de Google Cloud Console.
activePolylineCustomization optional
Personnalisation appliquée à la polyligne active. Une polyligne active correspond à une partie du trajet que le véhicule emprunte actuellement.

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. (Sur cette invocation, le paramètre isNew de l'objet des 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 position 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.

Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une 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 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 du repère, avant qu'il ne soit ajouté à la vue de la carte. (À cet appel, le paramètre isNew de l'objet des paramètres de fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de position 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 destination.

Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une 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 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 du repère, avant qu'il ne soit ajouté à la vue de la carte. (À cet appel, le paramètre isNew de l'objet des paramètres de fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de position 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
Durée minimale entre l'extraction des mises à jour de position, en millisecondes. Si l'extraction d'une mise à jour de position prend plus de pollingIntervalMillis, la mise à jour suivante ne commence pas tant que la mise à jour actuelle n'est pas terminée.

Définir cette valeur sur 0, Infinity ou une valeur négative désactive les mises à jour automatiques de la position. 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 l'envoi du fournisseur de position de l'envoi) ou une option de filtrage (par exemple, les limites de la vue ou les filtres d'attributs pour les fournisseurs de position de flotte) change.

L'intervalle de sondage par défaut et minimal est de 5 000 millisecondes. Si vous définissez l'intervalle de sondage sur une valeur positive inférieure, la valeur 5 000 est stockée et utilisée.
remainingPolylineCustomization optional
Personnalisation appliquée à la partie restante de la polyligne. Une polyligne restante correspond à une partie du trajet 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. (Sur cette invocation, le paramètre isNew de l'objet des 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 position 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 enregistrée. Une polyligne prise correspond à une partie du trajet 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. (Sur cette invocation, le paramètre isNew de l'objet des 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 position 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 position. Si cet élément n'est pas spécifié, le fournisseur de position ne commence à suivre 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 d'é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ées par la mise à jour. Non modifiable.