Suivez votre parc avec la bibliothèque de suivi du parc JavaScript

La bibliothèque JavaScript Fleet Tracking Library vous permet de visualiser la position des véhicules dans leurs flottes en temps quasi réel. La bibliothèque utilise l'API Deliveries pour permettre la visualisation des véhicules de livraison ainsi que des tâches. Tout comme la bibliothèque de suivi des expéditions JavaScript, elle contient un composant de carte JavaScript qui remplace directement une entité google.maps.Map standard et des composants de données à connecter à Fleet Engine.

Composants

La bibliothèque JavaScript de suivi de parc fournit des composants permettant de visualiser les véhicules de livraison et les arrêts, ainsi que des flux de données brutes pour l'heure d'arrivée prévue ou la distance restante avant une livraison.

Vue plan du suivi de flotte

Le composant de vue plan du suivi du parc permet de visualiser l'emplacement des véhicules et les tâches à effectuer. Si l'itinéraire d'un véhicule est connu, le composant de vue plan anime ce véhicule à mesure qu'il se déplace le long de sa trajectoire prédite.

Exemple de vue de carte pour le suivi de flotte

Fournisseurs de géolocalisation

Les fournisseurs de localisation utilisent les informations stockées dans Fleet Engine pour envoyer des informations de localisation des objets suivis dans la carte de partage de trajets.

Fournisseur de services de localisation des véhicules de livraison

Le fournisseur de localisation du véhicule de livraison affiche les informations de localisation d'un seul véhicule de livraison. Il contient des informations sur l'emplacement du véhicule ainsi que sur les tâches effectuées par le véhicule de livraison.

Fournisseur de géolocalisation de parc de livraison

Le fournisseur de localisation de la flotte de livraison affiche les informations de localisation de plusieurs véhicules. Vous pouvez filtrer les véhicules ou les emplacements spécifiques, ou afficher l'ensemble du parc.

Contrôler la visibilité des lieux suivis

Cette section décrit les règles de visibilité des objets de localisation suivis sur la carte pour le fournisseur de localisation prédéfini Fleet Engine. Les fournisseurs de localisation personnalisée ou dérivée peuvent modifier les règles de visibilité.

Véhicules de livraison

Un véhicule de livraison est visible dès sa création dans Fleet Engine, et reste visible tout au long de son itinéraire, quelles que soient ses tâches.

Repères d'emplacement des tâches

Les arrêts planifiés de véhicules sont affichés sur la carte en tant que repères d'arrêts pour véhicules. Les repères pour les tâches terminées s'affichent dans un style différent de celui des arrêts planifiés d'un véhicule.

L'emplacement des résultats de la tâche est affiché à l'aide de marqueurs de résultat de tâche. Les tâches dont le résultat est SUCCEEDED sont affichées avec des repères de tâches réussies, tandis que toutes les autres tâches sont affichées avec des repères de tâches ayant échoué.

Premiers pas avec la bibliothèque JavaScript de suivi de parc

Avant d'utiliser la bibliothèque JavaScript de suivi de parc, assurez-vous de bien connaître Fleet Engine et d'obtenir une clé API. Créez ensuite un ID de tâche et une revendication d'ID de véhicule de livraison.

Créer un ID de tâche et une revendication d'ID de véhicule de livraison

Pour suivre les véhicules de livraison à l'aide du fournisseur de localisation des véhicules de livraison, créez un jeton Web JSON (JWT) avec un ID de tâche et une revendication d'ID de véhicule de livraison.

Pour créer la charge utile JWT, ajoutez une revendication supplémentaire dans la section d'autorisation avec les clés taskid et deliveryvehicleid, puis définissez la valeur de chaque clé sur *. Le jeton doit être créé à l'aide du rôle Cloud IAM Super-utilisateur du service Fleet Engine. Notez que cela octroie un accès étendu à la création, à la lecture et à la modification des entités Fleet Engine, et ne doit être partagée qu'avec des utilisateurs de confiance.

L'exemple suivant montre comment créer un jeton pour le suivi par véhicule et par tâche:

{
  "alg": "RS256",
  "typ": "JWT",
  "kid": "private_key_id_of_consumer_service_account"
}
.
{
  "iss": "superuser@yourgcpproject.iam.gserviceaccount.com",
  "sub": "superuser@yourgcpproject.iam.gserviceaccount.com",
  "aud": "https://fleetengine.googleapis.com/",
  "iat": 1511900000,
  "exp": 1511903600,
  "scope": "https://www.googleapis.com/auth/xapi",
  "authorization": {
     "taskid": "*",
     "deliveryvehicleid": "*",
   }
}

Créer un outil de récupération de jetons d'authentification

Vous pouvez créer un extracteur de jetons d'authentification pour récupérer un jeton généré avec les revendications appropriées sur vos serveurs à l'aide d'un certificat de compte de service pour votre projet. Il est important de ne générer des jetons que sur vos serveurs et de ne jamais partager vos certificats sur des clients. Sinon, vous compromettrez la sécurité de votre système.

L'outil de récupération doit renvoyer une structure de données comportant deux champs, encapsulés dans une promesse:

  • Une chaîne token.
  • Un numéro expiresInSeconds. Un jeton expire dans ce délai après l'extraction.

La bibliothèque JavaScript de suivi de parc demande un jeton via l'outil de récupération de jetons d'authentification lorsque l'une des conditions suivantes est remplie:

  • Il ne possède pas de jeton valide, par exemple lorsqu'il n'a pas appelé l'extracteur lors d'un nouveau chargement de page ou lorsque l'extracteur n'est pas renvoyé avec un jeton.
  • Le jeton précédemment récupéré a expiré.
  • Le jeton qu'il a récupéré précédemment expire dans la minute qui suit.

Sinon, la bibliothèque utilise le jeton précédemment émis, qui est toujours valide, et n'appelle pas l'outil de récupération.

L'exemple suivant montre comment créer un outil de récupération de jetons d'authentification:

JavaScript

function authTokenFetcher(options) {
  // options is a record containing two keys called 
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.Token,
    expiresInSeconds: data.ExpiresInSeconds
  };
}

TypeScript

function authTokenFetcher(options: {
  serviceType: google.maps.journeySharing.FleetEngineServiceType,
  context: google.maps.journeySharing.AuthTokenContext,
}): Promise<google.maps.journeySharing.AuthToken> {
  // The developer should generate the correct
  // SERVER_TOKEN_URL based on options.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.token,
    expiresInSeconds: data.expiration_timestamp_ms - Date.now(),
  };
}

Lorsque vous implémentez le point de terminaison côté serveur pour la génération des jetons, tenez compte des points suivants:

  • Le point de terminaison doit renvoyer un délai d'expiration pour le jeton. Dans l'exemple ci-dessus, il est donné sous la forme data.ExpiresInSeconds.
  • L'outil de récupération des jetons d'authentification doit transmettre le délai d'expiration (en secondes, à partir du moment de l'extraction) à la bibliothèque, comme illustré dans l'exemple.
  • L'URL SERVER_TOKEN_URL dépend de l'implémentation de votre backend. Voici les URL de l'exemple de backend d'application :
    • https://SERVER_URL/token/delivery_driver/DELIVERY_VEHICLE_ID
    • https://SERVER_URL/token/delivery_consumer/TRACKING_ID
    • https://SERVER_URL/token/fleet_reader

Charger une carte à partir d'un fichier HTML

L'exemple suivant montre comment charger la bibliothèque de partage de parcours JavaScript à partir d'une URL spécifiée. Le paramètre de rappel exécute la fonction initMap après le chargement de l'API. L'attribut defer permet au navigateur de continuer à afficher le reste de votre page pendant le chargement de l'API.

<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=journeySharing" defer></script>

Suivre un véhicule de livraison

Cette section explique comment utiliser la bibliothèque JavaScript de suivi de parc pour suivre un véhicule de livraison. Veillez à charger la bibliothèque à partir de la fonction de rappel spécifiée dans la balise de script avant d'exécuter votre code.

Instancier un fournisseur de localisation des véhicules de livraison

La bibliothèque de suivi de parc JavaScript prédéfinit un fournisseur de localisation pour l'API Fleet Engine Deliveries. Utilisez votre ID de projet et une référence à votre fabrique de jetons pour l'instancier.

JavaScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryVehicleLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, you may specify 
          // deliveryVehicleId to immediately start
          // tracking.
          deliveryVehicleId: 'your-delivery-id',
});

TypeScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryVehicleLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, you may specify
          // deliveryVehicleId to immediately start
          // tracking.
          deliveryVehicleId: 'your-delivery-id',
});

Initialiser la vue plan

Après avoir chargé la bibliothèque de partage de parcours JavaScript, initialisez la vue plan et ajoutez-la à la page HTML. Votre page doit contenir un élément <div> qui contient la vue de la carte. L'élément <div> s'appelle map_canvas dans l'exemple ci-dessous.

JavaScript

const mapView = new 
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'), 
  locationProviders: [locationProvider],
  // Styling customizations; see below.
  vehicleMarkerSetup: vehicleMarkerSetup,
  anticipatedRoutePolylineSetup:
      anticipatedRoutePolylineSetup,
  // Any undefined styling options will use defaults.
});

// If you did not specify a delivery vehicle ID in the 
// location provider constructor, you may do so here.
// Location tracking will start as soon as this is set.
locationProvider.deliveryVehicleId 
                        = 'your-delivery-vehicle-id';

// Give the map an initial viewport to allow it to 
// initialize; otherwise the 'ready' event above may 
// not fire. The user also has access to the mapView
// object to customize as they wish.
mapView.map.setCenter('Times Square, New York, NY');
mapView.map.setZoom(14);

TypeScript

const mapView = new 
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  // Styling customizations; see below.
  vehicleMarkerSetup: vehicleMarkerSetup,
  anticipatedRoutePolylineSetup:
      anticipatedRoutePolylineSetup,
  // Any undefined styling options will use defaults.
});

// If you did not specify a delivery vehicle ID in the 
// location provider constructor, you may do so here.
// Location tracking will start as soon as this is set.
locationProvider.deliveryVehicleId 
                        = 'your-delivery-vehicle-id';

// Give the map an initial viewport to allow it to 
// initialize; otherwise the 'ready' event above may 
// not fire. The user also has access to the mapView 
// object to customize as they wish.
mapView.map.setCenter('Times Square, New York, NY');
mapView.map.setZoom(14);

Écouter les événements de modification

Vous pouvez récupérer des métadonnées sur une tâche à partir de l'objet deliveryVehicle à l'aide du fournisseur de localisation. Ces métadonnées incluent l'heure d'arrivée prévue et la distance restante avant le prochain retrait ou dépôt du véhicule. Les modifications apportées aux métadonnées déclenchent un événement update. L'exemple suivant montre comment écouter ces événements de modification.

JavaScript

locationProvider.addListener('update', e => {
  // e.deliveryVehicle contains data that may be        
  // useful to the rest of the UI.  
  if (e.deliveryVehicle) {
    console.log(e.deliveryVehicle.remainingDuration);
  }
});

TypeScript

locationProvider.addListener('update',
    (e: google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent) => {
  // e.deliveryVehicle contains data that may be
  // useful to the rest of the UI.
  if (e.deliveryVehicle) {
    console.log(e.deliveryVehicle.remainingDuration);
  }
});

Écouter les erreurs

Les erreurs survenant de manière asynchrone lors de la demande d'informations sur le véhicule de livraison déclenchent des événements d'erreur. L'exemple suivant montre comment écouter ces événements afin de gérer les erreurs.

JavaScript

locationProvider.addListener('error', e => {
  // e.error is the error that triggered the event.
  console.error(e.error);
});

TypeScript

locationProvider.addListener('error', (e: google.maps.ErrorEvent) => {
  // e.error is the error that triggered the event.
  console.error(e.error);
});

Arrêter le suivi

Pour empêcher le fournisseur de localisation de suivre le véhicule de livraison, supprimez l'ID du véhicule de livraison du fournisseur de localisation.

JavaScript

locationProvider.deliveryVehicleId = '';

TypeScript

locationProvider.deliveryVehicleId = '';

Supprimer le fournisseur de localisation de la vue plan

L'exemple suivant montre comment supprimer un fournisseur de localisation de la vue plan.

JavaScript

mapView.removeLocationProvider(locationProvider);

TypeScript

mapView.removeLocationProvider(locationProvider);

Afficher un parc de livraison

Cette section explique comment utiliser la bibliothèque de partage de parcours JavaScript pour afficher un parc de livraison. Veillez à charger la bibliothèque à partir de la fonction de rappel spécifiée dans la balise de script avant d'exécuter votre code.

Instancier un fournisseur de localisation de la flotte de livraison

La bibliothèque de suivi de parc JavaScript prédéfinit un fournisseur de services de localisation qui extrait plusieurs véhicules à partir de l'API FleetEngine Deliveries. Utilisez votre ID de projet et une référence à votre outil de récupération de jetons pour l'instancier.

JavaScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryFleetLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, specify location bounds to
          // limit which delivery vehicles are
          // retrieved and immediately start tracking.
          locationRestriction: {
            north: 37.3,
            east: -121.8,
            south: 37.1,
            west: -122,
          },
          // Optionally, specify a filter to limit
          // which delivery vehicles are retrieved.
          deliveryVehicleFilter:
            'attributes.foo = "bar" AND attributes.baz = "qux"',
        });

TypeScript

locationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryFleetLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, specify location bounds to
          // limit which delivery vehicles are
          // retrieved and immediately start tracking.
          locationRestriction: {
            north: 37.3,
            east: -121.8,
            south: 37.1,
            west: -122,
          },
          // Optionally, specify a filter to limit
          // which delivery vehicles are retrieved.
          deliveryVehicleFilter:
            'attributes.foo = "bar" AND attributes.baz = "qux"',
        });

deliveryVehicleFilter spécifie une requête permettant de filtrer les véhicules affichés sur la carte. Ce filtre est directement transmis à Fleet Engine. Consultez la section ListDeliveryVehiclesRequest.filter pour connaître les formats acceptés.

locationRestriction limite la zone dans laquelle afficher les véhicules sur la carte. Elle détermine également si le suivi de la position est activé ou non. Le suivi de la position ne démarre pas tant que ce paramètre n'est pas défini.

Une fois le fournisseur de localisation créé, initialisez la vue plan.

Définir une restriction d'emplacement à l'aide de la fenêtre d'affichage de la carte

Les limites de locationRestriction peuvent être configurées pour correspondre à la zone actuellement visible dans la vue plan.

JavaScript

google.maps.event.addListenerOnce(
  mapView.map, 'bounds_changed', () => {
    const bounds = mapView.map.getBounds();
    if (bounds) {
      // If you did not specify a location restriction in the
      // location provider constructor, you may do so here.
      // Location tracking will start as soon as this is set.
      locationProvider.locationRestriction = bounds;
    }
  });

TypeScript

google.maps.event.addListenerOnce(
  mapView.map, 'bounds_changed', () => {
    const bounds = mapView.map.getBounds();
    if (bounds) {
      // If you did not specify a location restriction in the
      // location provider constructor, you may do so here.
      // Location tracking will start as soon as this is set.
      locationProvider.locationRestriction = bounds;
    }
  });

Écouter les événements de modification

Vous pouvez récupérer des métadonnées sur le parc à partir de l'objet deliveryVehicles à l'aide du fournisseur de localisation. Ces métadonnées incluent les propriétés du véhicule, telles que l'état de la navigation, la distance restante et les attributs personnalisés. Pour en savoir plus, consultez la documentation de référence. La modification des métadonnées déclenche un événement update. L'exemple suivant montre comment écouter ces événements de modification.

JavaScript

locationProvider.addListener('update', e => {
  // e.deliveryVehicles contains data that may be
  // useful to the rest of the UI.
  if (e.deliveryVehicles) {
    for (vehicle of e.deliveryVehicles) {
      console.log(vehicle.remainingDistanceMeters);
    }
  }
});

TypeScript

locationProvider.addListener('update',
    (e: google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent) => {
  // e.deliveryVehicles contains data that may be
  // useful to the rest of the UI.
  if (e.deliveryVehicles) {
    for (vehicle of e.deliveryVehicles) {
      console.log(vehicle.remainingDistanceMeters);
    }
  }
});

Écouter les erreurs

Les erreurs survenant de manière asynchrone lors de la demande d'informations sur le parc de livraison déclenchent des événements d'erreur. Pour obtenir des exemples montrant comment écouter ces événements, consultez la section Écouter les erreurs.

Arrêter le suivi

Pour empêcher le fournisseur de localisation de suivre la flotte de livraison, définissez ses limites sur la valeur "null".

JavaScript

locationProvider.locationRestriction = null;

TypeScript

locationProvider.locationRestriction = null;

Supprimer le fournisseur de localisation de la vue plan

L'exemple suivant montre comment supprimer un fournisseur de localisation de la vue plan.

JavaScript

mapView.removeLocationProvider(locationProvider);

TypeScript

mapView.removeLocationProvider(locationProvider);

Suivez un véhicule de livraison et suivez une flotte de livraison

Lorsque vous affichez un parc, vous pouvez afficher l'itinéraire et les tâches à venir d'un véhicule de livraison spécifique. Pour ce faire, instanciez à la fois un fournisseur de localisation de véhicules de livraison et un fournisseur de localisation de véhicule de livraison, puis ajoutez-les tous les deux à la vue de la carte:

JavaScript

deliveryFleetLocationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryFleetLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, specify location bounds to
          // limit which delivery vehicles are
          // retrieved and immediately start tracking.
          locationRestriction: {
            north: 37.3,
            east: -121.8,
            south: 37.1,
            west: -122,
          },
          // Optionally, specify a filter to limit
          // which delivery vehicles are retrieved.
          deliveryVehicleFilter:
            'attributes.foo = "bar" AND attributes.baz = "qux"',
        });

deliveryVehicleLocationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryVehicleLocationProvider({
          projectId,
          authTokenFetcher
        });

const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [
    deliveryFleetLocationProvider,
    deliveryVehicleLocationProvider,
  ],
  // Any other options
});

TypeScript

deliveryFleetLocationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryFleetLocationProvider({
          projectId,
          authTokenFetcher,

          // Optionally, specify location bounds to
          // limit which delivery vehicles are
          // retrieved and immediately start tracking.
          locationRestriction: {
            north: 37.3,
            east: -121.8,
            south: 37.1,
            west: -122,
          },
          // Optionally, specify a filter to limit
          // which delivery vehicles are retrieved.
          deliveryVehicleFilter:
            'attributes.foo = "bar" AND attributes.baz = "qux"',
        });

deliveryVehicleLocationProvider =
    new google.maps.journeySharing
        .FleetEngineDeliveryVehicleLocationProvider({
          projectId,
          authTokenFetcher
        });

const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [
    deliveryFleetLocationProvider,
    deliveryVehicleLocationProvider,
  ],
  // Any other options
});

Le fournisseur de localisation de la flotte de livraison commence à afficher les véhicules de livraison sur la carte. Utilisez la personnalisation des repères pour permettre au fournisseur de localisation du véhicule de livraison de suivre un véhicule de livraison lorsqu'un clic a été effectué sur le repère de son parc:

JavaScript

// Specify the customization function either separately, or as a field in
// the options for the delivery fleet location provider constructor.
deliveryFleetLocationProvider.deliveryVehicleMarkerCustomization =
  (params) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // params.vehicle.name follows the format
        // "providers/{provider}/deliveryVehicles/{vehicleId}".
        // Only the vehicleId portion is used for the delivery vehicle
        // location provider.
        deliveryVehicleLocationProvider.deliveryVehicleId =
            params.vehicle.name.split('/').pop();
      });
    }
  };

TypeScript

// Specify the customization function either separately, or as a field in
// the options for the delivery fleet location provider constructor.
deliveryFleetLocationProvider.deliveryVehicleMarkerCustomization =
  (params: google.maps.journeySharing.DeliveryVehicleMarkerCustomizationFunctionParams) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // params.vehicle.name follows the format
        // "providers/{provider}/deliveryVehicles/{vehicleId}".
        // Only the vehicleId portion is used for the delivery vehicle
        // location provider.
        deliveryVehicleLocationProvider.deliveryVehicleId =
            params.vehicle.name.split('/').pop();
      });
    }
  };

Masquez le repère pour le fournisseur de localisation du véhicule de livraison afin d'éviter d'afficher deux repères pour le même véhicule:

JavaScript

// Specify the customization function either separately, or as a field in 
// the options for the delivery vehicle location provider constructor.
deliveryVehicleLocationProvider.deliveryVehicleMarkerCustomization =
  (params) => {
    if (params.isNew) {
      params.marker.setVisible(false);
    }
  };

TypeScript

// Specify the customization function either separately, or as a field in
// the options for the delivery vehicle location provider constructor.
deliveryVehicleLocationProvider.deliveryVehicleMarkerCustomization =
  (params: deliveryVehicleMarkerCustomizationFunctionParams) => {
    if (params.isNew) {
      params.marker.setVisible(false);
    }
  };

Personnaliser l'apparence de la carte de base

Pour personnaliser l'apparence du composant Maps, appliquez un style à votre carte à l'aide d'outils cloud ou en définissant des options directement dans le code.

Utiliser la personnalisation de cartes dans Google Cloud

La personnalisation de cartes dans Google Cloud vous permet de créer et de modifier des styles de carte pour toutes vos applications qui utilisent Google Maps à partir de la console Google Cloud, sans avoir à modifier votre code. Les styles de carte sont enregistrés en tant qu'ID de carte dans votre projet Cloud. Pour appliquer un style à votre carte de suivi de parc JavaScript, spécifiez un mapId lorsque vous créez le JourneySharingMapView. Le champ mapId ne peut pas être modifié ni ajouté après l'instanciation de JourneySharingMapView. L'exemple suivant montre comment activer un style de carte créé précédemment avec un ID de carte.

JavaScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    mapId: 'YOUR_MAP_ID'
  }
});

TypeScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    mapId: 'YOUR_MAP_ID'
  }
});

Utiliser le style de carte basé sur du code

Une autre façon de personnaliser le style de la carte consiste à définir mapOptions lorsque vous créez le JourneySharingMapView.

JavaScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    styles: [
      {
        "featureType": "road.arterial",
        "elementType": "geometry",
        "stylers": [
          { "color": "#CCFFFF" }
        ]
      }
    ]
  }
});

TypeScript

const mapView = new google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  mapOptions: {
    styles: [
      {
        "featureType": "road.arterial",
        "elementType": "geometry",
        "stylers": [
          { "color": "#CCFFFF" }
        ]
      }
    ]
  }
});

Modifier le style et la visibilité des itinéraires

Pour configurer le style et la visibilité des routes empruntées et anticipées, utilisez les options de style personnalisé. Pour en savoir plus, consultez la section Interface de PolylineOptions.

L'exemple suivant montre comment configurer le style et la visibilité des itinéraires anticipés. Pour configurer le style et la visibilité des routes empruntées, utilisez takenRoutePolylineSetup au lieu de anticipatedRoutePolylineSetup.

JavaScript

// This function is specified in the 
// JourneySharingMapView constructor's options 
// parameter.
function anticipatedRoutePolylineSetup({
    defaultPolylineOptions, defaultVisible}) {
  // If this function is not specified, the 
  // PolylineOptions object contained in 
  // defaultPolylineOptions is used to render the
  // anticipated route polyline. visible property sets the
  // polyline's visibility. Modify this object and 
  // pass it back to customize the style of the map.
  defaultPolylineOptions.strokeOpacity = 0.5;
  defaultPolylineOptions.strokeColor = 'red';
  return {
    polylineOptions: defaultPolylineOptions,
    visible: true
  };
}

// As an alternative, set static PolylineOptions to
// use for the anticipated route.
const anticipatedRoutePolylineOptionsSetup = {
  polylineOptions: {
    strokeOpacity: 0.5,
    strokeColor: 'red',
    …
  },
  visible: true,
};

TypeScript

// This function is specified in the 
// JourneySharingMapView constructor's options 
// parameter.
function anticipatedRoutePolylineSetup(options: {
  defaultPolylineOptions: google.maps.PolylineOptions,
  visible: boolean,
}): {
  polylineOptions: google.maps.PolylineOptions,
  visible: boolean,
} {
  // If this function is not specified, the 
  // PolylineOptions object contained in 
  // defaultPolylineOptions is used to render the
  // anticipated route polyline. visible property sets the
  // polyline's visibility. Modify this object and 
  // pass it back to customize the style of the map.
  options.defaultPolylineOptions.strokeOpacity = 0.5;
  options.defaultPolylineOptions.strokeColor = 'red';
  return {
    polylineOptions: options.defaultPolylineOptions,
    visible: true
  };
}

// As an alternative, set static PolylineOptions to
// use for the anticipated route.
const anticipatedRoutePolylineSetup = {
  polylineOptions: {
    strokeOpacity: 0.5,
    strokeColor: 'red',
    …
  },
  visible: true,
};

Utiliser des personnalisations de repère

La bibliothèque JavaScript de suivi de parc vous permet de personnaliser l'apparence des repères ajoutés à la carte. Pour ce faire, spécifiez les personnalisations des repères, que la bibliothèque Fleet Tracking Library applique ensuite avant d'ajouter des repères à la carte et à chaque mise à jour de repère.

La personnalisation la plus simple consiste à spécifier un objet MarkerOptions qui sera appliqué à tous les repères du même type. Les modifications spécifiées dans l'objet sont appliquées après la création de chaque repère, remplaçant les options par défaut.

Une option plus avancée consiste à spécifier une fonction de personnalisation. Les fonctions de personnalisation permettent de styliser les repères en fonction des données et d'ajouter de l'interactivité aux repères, comme la gestion des clics. Plus précisément, le suivi du parc transmet à la fonction de personnalisation des données sur le type d'objet représenté par le repère: véhicule, arrêt ou tâche. Cela permet ensuite de modifier le style du repère en fonction de l'état actuel de l'élément de repère lui-même (par exemple, le nombre d'arrêts restants ou le type de tâche). Vous pouvez même effectuer une jointure avec des données provenant de sources extérieures à Fleet Engine et styliser le repère en fonction de ces informations.

Vous pouvez également utiliser des fonctions de personnalisation pour filtrer la visibilité des repères. Pour ce faire, appelez setVisible(false) sur le repère.

Toutefois, pour des raisons de performances, nous vous recommandons de filtrer avec le filtrage natif du fournisseur de localisation, tel que FleetEngineDeliveryFleetLocationProvider.deliveryVehicleFilter. Cela dit, lorsque vous avez besoin de fonctionnalités de filtrage supplémentaires, vous pouvez appliquer un filtrage à l'aide de la fonction de personnalisation.

La bibliothèque de suivi de parc fournit les paramètres de personnalisation suivants:

Modifier le style des repères avec MarkerOptions

L'exemple suivant montre comment configurer le style d'un repère de véhicule avec un objet MarkerOptions. Suivez ce modèle pour personnaliser le style de n'importe quel repère à l'aide de l'un des paramètres de personnalisation répertoriés ci-dessus.

JavaScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

TypeScript

deliveryVehicleMarkerCustomization = {
  cursor: 'grab'
};

Modifier le style des repères à l'aide de fonctions de personnalisation

L'exemple suivant montre comment configurer le style d'un repère de véhicule. Suivez ce modèle pour personnaliser le style de n'importe quel repère à l'aide de l'un des paramètres de personnalisation de repère listés ci-dessus.

JavaScript

deliveryVehicleMarkerCustomization =
  (params) => {
    var stopsLeft = params.vehicle.remainingVehicleJourneySegments.length;
    params.marker.setLabel(`${stopsLeft}`);
  };

TypeScript

deliveryVehicleMarkerCustomization =
  (params: DeliveryVehicleMarkerCustomizationFunctionParams) => {
    var stopsLeft = params.vehicle.remainingVehicleJourneySegments.length;
    params.marker.setLabel(`${stopsLeft}`);
  };

Ajouter la gestion des clics aux repères

L'exemple suivant montre comment ajouter la gestion des clics à un repère de véhicule. Suivez ce modèle pour ajouter la gestion des clics à n'importe quel repère à l'aide de l'un des paramètres de personnalisation de repère répertoriés ci-dessus.

JavaScript

deliveryVehicleMarkerCustomization =
  (params) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // Perform desired action.
      });
    }
  };

TypeScript

deliveryVehicleMarkerCustomization =
  (params: DeliveryVehicleMarkerCustomizationFunctionParams) => {
    if (params.isNew) {
      params.marker.addListener('click', () => {
        // Perform desired action.
      });
    }
  };

Filtrer les repères visibles

L'exemple suivant montre comment filtrer les repères de véhicules visibles. Suivez cette procédure pour filtrer les repères en utilisant l'un des paramètres de personnalisation des repères répertoriés ci-dessus.

JavaScript

deliveryVehicleMarkerCustomization =
  (params) => {
    var stopsLeft = params.vehicle.remainingVehicleJourneySegments.length;
    if (stopsLeft > 10) {
      params.marker.setVisible(false);
    }
  };

TypeScript

deliveryVehicleMarkerCustomization =
  (params: DeliveryVehicleMarkerCustomizationFunctionParams) => {
    var stopsLeft = params.vehicle.remainingVehicleJourneySegments.length;
    if (stopsLeft > 10) {
      params.marker.setVisible(false);
    }
  };

Afficher un InfoWindow pour un véhicule ou un repère de position

Vous pouvez utiliser un InfoWindow pour afficher des informations supplémentaires sur un véhicule ou un repère de position.

L'exemple suivant montre comment créer un InfoWindow et l'associer à un repère de véhicule.

JavaScript

// 1. Create an info window.
const infoWindow = new google.maps.InfoWindow(
    {disableAutoPan: true});

// (Assumes a delivery vehicle location provider.)
locationProvider.addListener('update', e => {
  if (e.deliveryVehicle) {
    const distance = 
           e.deliveryVehicle.remainingDistanceMeters;
    infoWindow.setContent(
        `Your vehicle is ${distance}m away from the next task.`);

    // 2. Attach the info window to a vehicle marker.   
    // This property can return multiple markers.
    const marker = mapView.vehicleMarkers[0];
    infoWindow.open(mapView.map, marker);
  }
});

// 3. Close the info window.
infoWindow.close();

TypeScript

// 1. Create an info window.
const infoWindow = new google.maps.InfoWindow(
    {disableAutoPan: true});

// (Assumes a delivery vehicle location provider.)
locationProvider.addListener('update', (e: google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent) => {
  if (e.deliveryVehicle) {
    const distance = 
           e.deliveryVehicle.remainingDistanceMeters;
    infoWindow.setContent(
        `Your vehicle is ${distance}m away from the next task.`);

    // 2. Attach the info window to a vehicle marker.   
    // This property can return multiple markers.
    const marker = mapView.vehicleMarkers[0];
    infoWindow.open(mapView.map, marker);
  }
});

// 3. Close the info window.
infoWindow.close();

Désactiver l'ajustement automatique

Vous pouvez empêcher la carte d'ajuster automatiquement la fenêtre d'affichage au véhicule et à l'itinéraire anticipé en désactivant l'ajustement automatique. L'exemple suivant montre comment désactiver l'ajustement automatique lorsque vous configurez la vue de carte de partage de parcours.

JavaScript

const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  automaticViewportMode:
      google.maps.journeySharing
          .AutomaticViewportMode.NONE,
  ...
});

TypeScript

const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
  element: document.getElementById('map_canvas'),
  locationProviders: [locationProvider],
  automaticViewportMode:
      google.maps.journeySharing
          .AutomaticViewportMode.NONE,
  ...
});

Remplacer une carte existante

Vous pouvez remplacer une carte existante qui inclut des repères ou d'autres personnalisations sans les perdre.

Par exemple, supposons que vous ayez une page Web avec une entité google.maps.Map standard sur laquelle un repère est affiché:

<!DOCTYPE html>
<html>
  <head>
    <style>
       /* Set the size of the div element that contains the map */
      #map {
        height: 400px;  /* The height is 400 pixels */
        width: 100%;  /* The width is the width of the web page */
       }
    </style>
  </head>
  <body>
    <h3>My Google Maps Demo</h3>
    <!--The div element for the map -->
    <div id="map"></div>
    <script>
// Initialize and add the map
function initMap() {
  // The location of Uluru
  var uluru = {lat: -25.344, lng: 131.036};
  // The map, initially centered at Mountain View, CA.
  var map = new google.maps.Map(document.getElementById('map'));
  map.setOptions({center: {lat: 37.424069, lng: -122.0916944}, zoom: 14});

  // The marker, now positioned at Uluru
  var marker = new google.maps.Marker({position: uluru, map: map});
}
    </script>
    <!-- Load the API from the specified URL.
       * The async attribute allows the browser to render the page while the API loads.
       * The key parameter will contain your own API key (which is not needed for this tutorial).
       * The callback parameter executes the initMap() function.
    -->
    <script defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap">
    </script>
  </body>
</html>

Pour ajouter la bibliothèque de partage de parcours JavaScript, qui inclut le suivi de parc:

  1. Ajout du code pour la fabrique de jetons d'authentification.
  2. Initialisez un fournisseur de localisation dans la fonction initMap().
  3. Initialisez la vue plan dans la fonction initMap(). La vue contient la carte.
  4. Déplacez votre personnalisation dans la fonction de rappel pour l'initialisation de la vue plan.
  5. Ajoutez la bibliothèque d'emplacements au chargeur d'API.

L'exemple suivant présente les modifications à apporter:

<!DOCTYPE html>
<html>
  <head>
    <style>
       /* Set the size of the div element that contains the map */
      #map {
        height: 400px;  /* The height is 400 pixels */
        width: 100%;  /* The width is the width of the web page */
       }
    </style>
  </head>
  <body>
    <h3>My Google Maps Demo</h3>
    <!--The div element for the map -->
    <div id="map"></div>
    <script>
let locationProvider;

// (1) Authentication Token Fetcher
function authTokenFetcher(options) {
  // options is a record containing two keys called 
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
      if (!response.ok) {
        throw new Error(response.statusText);
      }
      const data = await response.json();
      return {
        token: data.Token,
        expiresInSeconds: data.ExpiresInSeconds
      };
}

// Initialize and add the map
function initMap() {
  // (2) Initialize location provider. Use FleetEngineDeliveryVehicleLocationProvider
  // as appropriate.
  locationProvider = new google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider({
    YOUR_PROVIDER_ID,
    authTokenFetcher,
  });

  // (3) Initialize map view (which contains the map).
  const mapView = new google.maps.journeySharing.JourneySharingMapView({
    element: document.getElementById('map'),
    locationProviders: [locationProvider],
    // any styling options
  });

mapView.addListener('ready', () => {
  locationProvider.deliveryVehicleId = DELIVERY_VEHICLE_ID;

    // (4) Add customizations like before.

    // The location of Uluru
    var uluru = {lat: -25.344, lng: 131.036};
    // The map, initially centered at Mountain View, CA.
    var map = mapView.map;
    map.setOptions({center: {lat: 37.424069, lng: -122.0916944}, zoom: 14});
    // The marker, now positioned at Uluru
    var marker = new google.maps.Marker({position: uluru, map: map});
  };
}
    </script>
    <!-- Load the API from the specified URL
      * The async attribute allows the browser to render the page while the API loads
      * The key parameter will contain your own API key (which is not needed for this tutorial)
      * The callback parameter executes the initMap() function
      *
      * (5) Add the journey sharing library to the API loader, which includes Fleet Tracking functionality.
    -->
    <script defer
    src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap&libraries=journeySharing">
    </script>
  </body>
</html>

Si vous conduisez un véhicule de livraison avec l'ID spécifié à proximité d'Uluru, il s'affiche désormais sur la carte.