Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider class

Classe google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider

Fournisseur de localisation des véhicules de livraison.

Cette classe étend PollingLocationProvider.

Accédez-y en appelant le const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing").
 Consultez Bibliothèques de l'API Maps JavaScript.

FleetEngineDeliveryVehicleLocationProvider
FleetEngineDeliveryVehicleLocationProvider(options)
Paramètres :
Crée un fournisseur de localisation pour un véhicule de livraison Fleet Engine.
deliveryVehicleId
Type : string
ID du véhicule observé par ce fournisseur de localisation. Définissez ce champ pour suivre un véhicule.
shouldShowOutcomeLocations
Type : boolean optional
Vous pouvez également autoriser les utilisateurs à afficher le lieu du résultat de la tâche.
shouldShowTasks
Type : boolean optional
Vous pouvez éventuellement autoriser les utilisateurs à afficher les tâches récupérées.
staleLocationThresholdMillis
Type : number
Ce champ est en lecture seule. Seuil pour la localisation obsolète du véhicule. Si la dernière position mise à jour du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas.
taskFilterOptions
Renvoie les options de filtre à appliquer lors de la récupération des tâches.
Hérité : isPolling, pollingIntervalMillis
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 demande de mise à jour des données Fleet Engine est terminée.
Hérité : ispollingchange

Interface FleetEngineDeliveryVehicleLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions

Options pour le fournisseur de localisation des véhicules de livraison.

authTokenFetcher
Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine.
projectId
Type : string
ID du projet du consommateur dans 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 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 dans l'objet des 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 DeliveryVehiclePolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
deliveryVehicleId optional
Type : string optional
ID du véhicule de livraison à suivre immédiatement après l'instanciation du fournisseur de localisation. Si aucun n'est spécifié, le fournisseur de localisation ne commence à suivre aucun véhicule. Utilisez FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId pour définir l'ID et commencer le suivi.
deliveryVehicleMarkerCustomization optional
Personnalisation appliquée au repère du véhicule de livraison.

Ce champ vous permet de 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 lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des 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 DeliveryVehicleMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
plannedStopMarkerCustomization optional
Personnalisation appliquée à un repère d'arrêt planifié.

Ce champ vous permet de 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 lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des 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 PlannedStopMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
pollingIntervalMillis optional
Type : number optional
Durée minimale 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 n'est pas lancée tant que la mise à jour en cours n'est pas terminée.

Définir cette valeur sur 0 désactive les mises à jour récurrentes de la position. Une nouvelle mise à jour de la position est récupérée si l'un des paramètres observés par le fournisseur de localisation change.

L'intervalle d'interrogation par défaut est de 5 000 millisecondes, soit l'intervalle minimal. Si vous définissez l'intervalle d'interrogation sur une valeur non nulle inférieure, 5 000 est utilisé.
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 empruntée.

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 dans l'objet des 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 DeliveryVehiclePolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
shouldShowOutcomeLocations optional
Type : boolean optional
Valeur booléenne permettant d'afficher ou de masquer les emplacements des résultats pour les tâches récupérées.
shouldShowTasks optional
Type : boolean optional
Valeur booléenne permettant d'afficher ou de masquer les tâches. Si vous définissez cette valeur sur "false", le point de terminaison ListTasks ne sera pas appelé pour récupérer les tâches. Seuls les arrêts à venir du véhicule seront affichés.
staleLocationThresholdMillis optional
Type : number optional
Seuil pour la localisation obsolète du véhicule. Si la dernière position mise à jour du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à 0 ou à Infinity, il sera ignoré et l'emplacement du véhicule ne sera pas considéré comme obsolète.
takenPolylineCustomization optional
Personnalisation appliquée à la polyligne tracé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 dans l'objet des 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 DeliveryVehiclePolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
taskFilterOptions optional
Options de filtre à appliquer lors de la récupération des tâches. Les options peuvent inclure un véhicule, une heure et un état de tâche spécifiques.
taskMarkerCustomization optional
Type : (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée à un repère de tâche. Un repère de tâche est affiché à l'emplacement prévu de chaque tâche attribuée au véhicule de livraison.

Ce champ vous permet de 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 lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des 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 TaskMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
taskOutcomeMarkerCustomization optional
Type : function(TaskMarkerCustomizationFunctionParams): void optional
Personnalisation appliquée à un repère de résultat de tâche. Un indicateur de résultat de tâche est affiché à l'emplacement du résultat réel de chaque tâche attribuée au véhicule de livraison.

Ce champ vous permet de 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 lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des 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 TaskMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.

Interface FleetEngineTaskFilterOptions

Interface google.maps.journeySharing.FleetEngineTaskFilterOptions

Options de filtrage des tâches dans le fournisseur de localisation des véhicules de livraison.

completionTimeFrom optional
Type : Date optional
Limite inférieure exclusive pour la durée d'exécution de la tâche. Permet de filtrer les tâches qui ont été effectuées après l'heure spécifiée.
completionTimeTo optional
Type : Date optional
Limite supérieure exclusive pour la durée d'exécution de la tâche. Permet de filtrer les tâches qui ont été effectuées avant l'heure spécifiée.
state optional
Type : string optional
État de la tâche. Les valeurs valides sont "OPEN" (OUVERT) ou "CLOSED" (FERMÉ).

Interface FleetEngineDeliveryVehicleLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent

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

completedVehicleJourneySegments optional
Type : Array<VehicleJourneySegment> optional
Segments de trajet effectués par ce véhicule. Non modifiable.
deliveryVehicle optional
Type : DeliveryVehicle optional
Structure de données du véhicule de livraison renvoyée par la mise à jour. Non modifiable.
tasks optional
Type : Array<Task> optional
Liste des tâches effectuées par ce véhicule de livraison. Non modifiable.

FleetEngineDeliveryFleetLocationProvider class

Classe google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider

Fournisseur de localisation de la flotte de livraison.

Cette classe étend PollingLocationProvider.

Accédez-y en appelant le const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing").
 Consultez Bibliothèques de l'API Maps JavaScript.

FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
Paramètres :
Crée un fournisseur de localisation pour les véhicules suivis par Fleet Engine.
deliveryVehicleFilter
Type : string optional
Filtre appliqué lors de la récupération des véhicules de livraison.
locationRestriction
Limites dans lesquelles suivre les véhicules de livraison. Si aucune limite n'est définie, aucun véhicule de livraison ne sera suivi. Pour suivre tous les véhicules de livraison, quelle que soit leur position, définissez des limites équivalentes à l'ensemble de la Terre.
staleLocationThresholdMillis
Type : number
Ce champ est en lecture seule. Seuil pour la localisation obsolète du véhicule. Si la dernière position mise à jour du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas.
Hérité : isPolling, pollingIntervalMillis
Hérité : addListener
update
function(event)
Événement déclenché lorsqu'une demande de mise à jour des données Fleet Engine est terminée.
Hérité : ispollingchange

Interface FleetEngineDeliveryFleetLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions

Options pour le fournisseur de localisation de la flotte de livraison.

authTokenFetcher
Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine.
projectId
Type : string
ID du projet du consommateur dans la console Google Cloud.
deliveryVehicleFilter optional
Type : string optional
Requête de filtre à appliquer lors de la récupération des véhicules de livraison. Ce filtre est transmis directement à Fleet Engine.

Consultez ListDeliveryVehiclesRequest.filter pour connaître les formats acceptés.

Notez que les filtres valides pour les attributs doivent comporter le préfixe "attributes". Par exemple, attributes.x = "y" ou attributes."x y" = "z".
deliveryVehicleMarkerCustomization optional
Type : function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional
Personnalisation appliquée à un repère de véhicule de livraison.

Ce champ vous permet de 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 lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des 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 DeliveryVehicleMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
locationRestriction optional
Limites de latitude/longitude dans lesquelles suivre les véhicules immédiatement après l'instanciation du fournisseur de localisation. Si elle n'est pas définie, le fournisseur de localisation ne commence pas à suivre les véhicules. Utilisez FleetEngineDeliveryFleetLocationProvider.locationRestriction pour définir les limites et commencer le suivi. Pour suivre tous les véhicules de livraison, quelle que soit leur position, définissez des limites équivalentes à l'ensemble de la Terre.
staleLocationThresholdMillis optional
Type : number optional
Seuil pour la localisation obsolète du véhicule. Si la dernière position mise à jour du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à zéro ou à Infinity, il sera ignoré et la position du véhicule ne sera pas considérée comme obsolète.

Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent

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

deliveryVehicles optional
Type : Array<DeliveryVehicle> optional
Liste des véhicules de livraison renvoyée par la requête. Non modifiable.