Le SDK client JavaScript permet à une application Web grand public d'afficher sur une carte la position des véhicules et d'autres lieux d'intérêt suivis dans Fleet Engine. Les clients peuvent ainsi suivre la progression d'un trajet à la demande ou d'un envoi planifié. Elle se charge en tant que bibliothèque journeySharing de l'API Maps JavaScript.
SDK client JavaScript : points clés
- Produit : SDK client JavaScript
- Également appelé : SDK Consumer pour JavaScript, JavaScript pour les trajets à la demande des services de mobilité, SDK JavaScript
- Catégorie : Routes
- Plate-forme : JavaScript (navigateur)
- Exécution sur : client (code de l'application ou du navigateur)
- Étape de lancement : GA
- Cycle de vie : Actif
- Présentation : Présentation du SDK Consumer pour JavaScript
SDK client JavaScript : quand l'utiliser ?
Utilisez le SDK Consumer pour JavaScript dans les cas suivants :
- Vous devez afficher la position et l'itinéraire d'un véhicule en temps réel pour un trajet à la demande suivi par Fleet Engine, sur une page Web ou dans une application Web.
- Vous devez permettre aux clients de suivre la progression du retrait ou de la livraison d'un envoi planifié suivi dans Fleet Engine dans un navigateur.
- Vous devez afficher l'heure d'arrivée prévue, la distance restante et le trafic en temps réel sur l'itinéraire d'un trajet dans une vue de carte Web.
- Vous devez personnaliser les repères de trajet, les polylignes d'itinéraire ou le style de carte dans une vue de suivi Web pour les clients.
Ne pas utiliser le SDK Consumer JavaScript dans les cas suivants :
- Vous avez besoin d'une expérience client de suivi de trajet dans une application Android native. Utilisez plutôt le SDK Consumer pour Android.
- Vous avez besoin d'une expérience client de suivi de trajet dans une application iOS native. Utilisez plutôt le SDK client pour iOS.
- Vous devez signaler la position du conducteur et la progression du trajet à Fleet Engine depuis l'application Android du conducteur. Utilisez plutôt le SDK Driver pour Android.
- Vous devez signaler la position du conducteur et la progression du trajet depuis l'application iOS du conducteur vers Fleet Engine. Utilisez plutôt le SDK Driver pour iOS.
- Vous avez besoin d'une carte Web générale qui ne suit pas les trajets ni les tâches Fleet Engine. Utilisez plutôt l'API Maps JavaScript.
SDK client JavaScript : configuration
- Authentification : clé API, jeton Web JSON (JWT)
- Activez également : l'API Maps JavaScript, le service Fleet Engine
- Attribution de l'utilisation : ID de transaction Mobility facultatif (bêta) : définissez
google.maps.Settings.getInstance().experienceIdssur un tableau d'ID de transaction Mobility (ou d'ID associés) avant de créer unJourneySharingMapView.experienceIdsn'est disponible que dans la versionv=betade l'API Maps JavaScript. - Premiers pas : Configurer le SDK Consumer pour JavaScript
- Référence : Documentation de référence du SDK Consumer pour JavaScript
- Notes de version : Notes de version du SDK Consumer pour JavaScript
SDK client JavaScript : produits associés
- Souvent utilisé avec : service Fleet Engine, API Maps JavaScript, SDK Driver pour Android, SDK Driver pour iOS
SDK client JavaScript : erreurs courantes
- Problème : Si vous ne définissez pas de fenêtre d'affichage initiale (centre et zoom) pour la carte
JourneySharingMapView, l'événement'ready'de la carte risque de ne pas se déclencher. Correction : AppelezmapView.map.setCenter(...)etmapView.map.setZoom(...)après avoir créé la vue de la carte. Consultez /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey. - Problème : les erreurs provenant de requêtes asynchrones d'informations sur le trajet ne sont pas générées. Ils n'arrivent que sous forme d'événements
'error'sur le fournisseur de localisation. Ils passent donc inaperçus, sauf si vous ajoutez un écouteur. Correction : AjoutezlocationProvider.addListener('error', ...)et encapsulez les appels de bibliothèque dans des blocstry...catch. Consultez /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey. - Problème : les classes
google.maps.journeySharingne sont pas disponibles, sauf si vous chargez la bibliothèquejourneySharing. Correction : Ajoutezlibraries=journeySharingà l'URL du script de l'API Maps JavaScript ou chargez les classes avecawait google.maps.importLibrary("journeySharing"). Consultez /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey. - Problème : Les appels Fleet Engine depuis le navigateur (un environnement peu fiable) nécessitent des jetons JWT émis par votre serveur backend. Une clé API seule ne permet pas d'accéder aux données de trajet. Solution : Émettez des jetons JWT à partir de votre backend et fournissez un
authTokenFetcherqui renvoie le jeton etexpiresInSeconds. Consultez /maps/documentation/mobility/journey-sharing/on-demand/javascript/setup.
SDK Consumer JavaScript : fonctionnalités anciennes et obsolètes
- Options de configuration des repères et des polylignes
JourneySharingMapViewetJourneySharingMapViewOptions(vehicleMarkerSetup,originMarkerSetup,destinationMarkerSetup,waypointMarkerSetup,anticipatedRoutePolylineSetup,takenRoutePolylineSetup, etc.) : Obsolètes. Remplacement : optionsMarkerCustomizationFunctionetPolylineCustomizationFunctionsur le fournisseur de localisation (par exemple,vehicleMarkerCustomization). Symptôme : suppression prévue dans une prochaine version. Consultez le guide de migration. JourneySharingMapView.locationProvideretJourneySharingMapViewOptions.locationProvider: Obsolète. Remplacement :JourneySharingMapView.locationProvidersetJourneySharingMapViewOptions.locationProviders.- Propriétés de liste de repères et de polylignes
JourneySharingMapView(vehicleMarkers,originMarkers,destinationMarkers,waypointMarkers,anticipatedRoutePolylines,takenRoutePolylineset propriétés de repère de tâche) : obsolètes. Remplacement : rappelsMarkerCustomizationFunctionetPolylineCustomizationFunctionsur le fournisseur de localisation. Consultez le guide de migration.
Ce que vous pouvez faire avec le SDK Consumer pour JavaScript
Consultez les guides associés ci-dessous pour chaque tâche ou comparez les produits dans l'explorateur de fonctionnalités.
- Ajoutez une polyligne d'itinéraire qui suit un trajet de Fleet Engine à une carte sur une page Web ou une application mobile.
- Mettez à jour la progression d'un trajet Fleet Engine sur un itinéraire dans une carte sur une page Web ou une application mobile.
- Modifiez le style des routes, des polylignes et des polygones sur une carte qui suit la progression d'un trajet depuis Fleet Engine.
- Afficher ou masquer les éléments cartographiques sur une carte qui suit la progression d'un trajet depuis Fleet Engine
- Modifiez le style des icônes et des libellés de texte sur une carte qui suit la progression d'un trajet depuis Fleet Engine.
- Appliquez différents styles de carte à différents niveaux de zoom sur une carte qui suit la progression d'un trajet depuis Fleet Engine.
- Modifiez la densité des lieux sur une carte qui suit la progression d'un trajet depuis Fleet Engine. Expérimental Remarque : La prise en charge des styles de cartes basés dans le cloud dans le SDK client est en disponibilité générale, tandis que le contrôle de la densité des points d'intérêt est une fonctionnalité expérimentale des styles de cartes basés dans le cloud (compatible uniquement avec les styles de cartes clairs).
- Modifiez le style des bâtiments sur une carte qui suit la progression d'un trajet depuis Fleet Engine. Expérimental Remarque : La compatibilité avec les styles de cartes basés dans le cloud dans le SDK Consumer est en disponibilité générale, tandis que la personnalisation des styles de bâtiments en 3D et d'empreintes est une fonctionnalité expérimentale des styles de cartes basés dans le cloud (compatible uniquement avec les styles de cartes clairs).
- Modifiez le style des points de repère sur une carte qui suit la progression d'un trajet depuis Fleet Engine. Expérimental Remarque : La prise en charge des styles de cartes basés dans le cloud dans le SDK Consumer est en disponibilité générale, tandis que la personnalisation des icônes de repères est une fonctionnalité expérimentale des styles de cartes basés dans le cloud (compatible uniquement avec les styles de cartes clairs).
- Personnalisez un repère sur une carte qui suit la progression d'un trajet depuis Fleet Engine.
- Personnalisez la polyligne d'itinéraire sur une carte qui suit la progression d'un trajet depuis Fleet Engine.