Seguire una spedizione

Ora che hai configurato l'SDK Consumer JavaScript per le attività pianificate, puoi seguire una spedizione con la tua app per utenti finali. Questo documento illustra i seguenti passaggi chiave di questo processo:

  • Inizializza una mappa e visualizza il percorso condiviso
  • Aggiorna e segui l'avanzamento del percorso
  • Smettere di seguire una spedizione
  • Gestisci gli errori di monitoraggio della spedizione

Configura una mappa

Per seguire il ritiro o la consegna di una spedizione nella tua app web, devi caricare una mappa e creare un'istanza dell'SDK Consumer per iniziare a monitorare la spedizione. Puoi caricare una nuova mappa o utilizzarne una esistente. Poi, utilizza la funzione di inizializzazione per creare un'istanza dell'SDK Consumer in modo che la visualizzazione mappa corrisponda alla posizione dell'elemento monitorato.

Carica una nuova mappa utilizzando l'API Maps JavaScript

Per creare una nuova mappa, carica l'API Maps JavaScript nella tua app web. L'esempio seguente mostra come caricare l'API Maps JavaScript, attivare l'SDK e attivare il controllo di inizializzazione.

  • Il parametro callback esegue la funzione initMap dopo il caricamento dell'API.
  • L'attributo defer consente al browser di continuare a eseguire il rendering del resto della pagina durante il caricamento dell'API.

Utilizza la funzione initMap per creare un'istanza del Consumer SDK. Ad esempio:

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

Carica una mappa esistente

Puoi anche caricare una mappa esistente creata dall'API Maps JavaScript, ad esempio una che stai già utilizzando.

Ad esempio, supponiamo di avere una pagina web con un'entità google.maps.Map standard su cui viene mostrato un indicatore, come definito nel seguente codice HTML. In questo modo, la mappa viene visualizzata utilizzando la stessa funzione initMap nel callback alla fine:

    <!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 Pier 39 in San Francisco
          var pier39 = {lat: 37.809326, lng: -122.409981};
          // 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 Pier 39
          var marker = new google.maps.Marker({position: pier39, map: map});
        }
        </script>
        <!-- Load the API from the specified URL.
           * The defer attribute allows the browser to render the page while the API loads.
           * The key parameter contains your own API key.
           * 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>

Crea un'istanza di un provider di località di spedizione

Utilizza il provider di località della spedizione, insieme all'analizzatore sintattico dei token di autorizzazione definito in precedenza, per iniziare a ricevere dati da Fleet Engine.

Questi esempi mostrano come creare un'istanza del provider di posizione.

JavaScript

const locationProvider =
  new google.maps.journeySharing.FleetEngineShipmentLocationProvider({
      projectId: 'your-project-id',
      authTokenFetcher: authTokenFetcher,  // the fetcher defined previously
  });

TypeScript

const locationProvider =
  new google.maps.journeySharing.FleetEngineShipmentLocationProvider({
      projectId: 'your-project-id',
      authTokenFetcher: authTokenFetcher,  // the fetcher defined previously
  });

Visualizza il percorso condiviso

Per visualizzare l'avanzamento di un'attività pianificata, inizializza la sua visualizzazione, che imposta il frame della mappa in modo che corrisponda alla località del percorso monitorato. L'avanzamento viene quindi fornito dall'SDK consumer dopo aver ricevuto le informazioni da Fleet Engine.

Suggerimenti:

  1. Assicurati che la pagina contenga un elemento <div> che contiene la visualizzazione mappa. Nel seguente esempio, l'elemento <div> è denominato map_canvas.

  2. Tieni presente le regole di visibilità predefinite applicate da Fleet Engine ai percorsi monitorati. Puoi anche configurare le regole di visibilità per le attività di spedizione del veicolo attivo e di sosta programmata. Consulta Personalizza la visibilità delle attività nella guida Configura le attività.

Questi esempi mostrano come inizializzare una visualizzazione mappa.

JavaScript

function initMap() {
  const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
    element: document.getElementById('map_canvas'),
    // Any undefined styling options use defaults.
  });

  // If you did not specify a tracking ID in the location
  // provider constructor, you may do so here.
  // Location tracking starts as soon as this is set.
  locationProvider.trackingId = 'your-tracking-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({lat: 37.2, lng: -121.9});
  mapView.map.setZoom(14);
}

TypeScript

function initMap() {
  const mapView = new
    google.maps.journeySharing.JourneySharingMapView({
    element: document.getElementById('map_canvas'),
   // Any undefined styling options will use defaults.
  });

  // If you did not specify a tracking ID in the location
  // provider constructor, you may do so here.
  // Location tracking starts as soon as this is set.
  locationProvider.trackingId = 'your-tracking-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({lat: 37.2, lng: -121.9});
  mapView.map.setZoom(14);
}

Aggiorna l'avanzamento della spedizione

Puoi ascoltare gli eventi e aggiornare l'avanzamento della spedizione man mano che il percorso procede. Utilizza il provider di località per recuperare le meta-informazioni dall'oggetto taskTrackingInfo. Le modifiche alle meta informazioni attivano un evento di aggiornamento. L'oggetto taskTrackingInfo fornisce quanto segue:

  • Data di completamento prevista
  • Numero di fermate rimanenti
  • Distanza rimanente prima del ritiro o della consegna

L'esempio seguente mostra come ascoltare questi eventi di modifica.

JavaScript

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

TypeScript

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

Criteri di visualizzazione per più attività

L'SDK Consumer per le attività pianificate mostra una sola attività per ID monitoraggio sulla mappa. Tuttavia, in genere assegni anche un ID monitoraggio a un articolo spedito specifico che rimane associato all'articolo durante tutto il suo percorso nel tuo sistema. Ciò significa che un singolo ID monitoraggio potrebbe essere associato a più attività, ad esempio un'attività di ritiro seguita da un'attività di consegna per lo stesso pacco o più attività di spedizione non riuscita per un pacco.

Per gestire questa situazione, Fleet Engine applica i criteri per la visualizzazione delle attività, mostrati nella tabella seguente.

Criteri delle attività Risultato
Apri le attività di ritiro
Ne esiste esattamente uno Mostra l'attività
Esistono più elementi Errore di generazione
Attività di ritiro chiuse
Ne esiste esattamente uno Mostra l'attività
Più esistenti (alcuni con tempi di esito) Mostra l'attività con l'ora del risultato più recente
Esistono più risultati (nessuno con l'ora del risultato) Errore di generazione
Apri le attività di pubblicazione
Ne esiste esattamente uno Mostra l'attività
Esistono più elementi Errore di generazione
Attività di consegna chiuse
Ne esiste esattamente uno Mostra l'attività
Più esistenti (alcuni con tempi di esito) Mostra l'attività con l'ora del risultato più recente
Esistono più risultati (nessuno con l'ora del risultato) Errore di generazione

Smettere di seguire una spedizione

Quando un percorso di spedizione viene completato o annullato, l'app per utenti finali deve interrompere il monitoraggio di una spedizione rimuovendo l'ID monitoraggio e il provider di geolocalizzazione dalla visualizzazione mappa. Per maggiori dettagli, vedi le sezioni seguenti.

Rimuovi l'ID monitoraggio

Per impedire al provider di posizione di monitorare la spedizione, rimuovi l'ID monitoraggio dal provider di posizione. Gli esempi riportati di seguito mostrano come fare.

JavaScript

locationProvider.trackingId = '';

TypeScript

locationProvider.trackingId = '';

Rimuovi il fornitore di posizione dalla visualizzazione mappa

L'esempio seguente mostra come rimuovere un provider di località dalla visualizzazione mappa.

JavaScript

mapView.removeLocationProvider(locationProvider);

TypeScript

mapView.removeLocationProvider(locationProvider);

Gestisci gli errori di monitoraggio della spedizione

Gli errori che si verificano in modo asincrono durante la richiesta delle informazioni sulla spedizione attivano gli eventi error. L'esempio seguente mostra come ascoltare questi eventi per gestire gli errori.

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);
});

Nota:assicurati di inserire le chiamate alla libreria in blocchi try...catch per gestire gli errori imprevisti.

Passaggi successivi