Guide de référence rapide du SDK client JavaScript

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

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 : Appelez mapView.map.setCenter(...) et mapView.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 : Ajoutez locationProvider.addListener('error', ...) et encapsulez les appels de bibliothèque dans des blocs try...catch. Consultez /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey.
  • Problème : les classes google.maps.journeySharing ne sont pas disponibles, sauf si vous chargez la bibliothèque journeySharing. Correction : Ajoutez libraries=journeySharing à l'URL du script de l'API Maps JavaScript ou chargez les classes avec await 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 authTokenFetcher qui renvoie le jeton et expiresInSeconds. 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 JourneySharingMapView et JourneySharingMapViewOptions (vehicleMarkerSetup, originMarkerSetup, destinationMarkerSetup, waypointMarkerSetup, anticipatedRoutePolylineSetup, takenRoutePolylineSetup, etc.) : Obsolètes. Remplacement : options MarkerCustomizationFunction et PolylineCustomizationFunction sur le fournisseur de localisation (par exemple, vehicleMarkerCustomization). Symptôme : suppression prévue dans une prochaine version. Consultez le guide de migration.
  • JourneySharingMapView.locationProvider et JourneySharingMapViewOptions.locationProvider : Obsolète. Remplacement : JourneySharingMapView.locationProviders et JourneySharingMapViewOptions.locationProviders.
  • Propriétés de liste de repères et de polylignes JourneySharingMapView (vehicleMarkers, originMarkers, destinationMarkers, waypointMarkers, anticipatedRoutePolylines, takenRoutePolylines et propriétés de repère de tâche) : obsolètes. Remplacement : rappels MarkerCustomizationFunction et PolylineCustomizationFunction sur 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.