Guida introduttiva all'SDK di Drive per Android

Requisiti minimi di sistema

Sul dispositivo mobile deve essere installato Android 6.0 (livello API 23) o versioni successive.

Configurazione della build e delle dipendenze

Le versioni dell'SDK driver 4.99 e successive sono disponibili nel Repository Maven di Google.

Gradle

Aggiungi quanto segue al tuo file build.gradle:

repositories {
    ...
    google()
}

Maven

Aggiungi quanto segue al tuo file pom.xml:

<project>
  ...
  <repositories>
    <repository>
      <id>google-maven-repository</id>
      <url>https://maven.google.com</url>
    </repository>
  </repositories>
  ...
</project>

Configurazione progetto

Per utilizzare l'SDK Driver, la tua app deve avere come target minSdkVersion 23 o versioni successive. Per ulteriori informazioni, vedi Note di rilascio.

Per eseguire un'app creata con l'SDK Driver, sul dispositivo Android deve essere installato Google Play Services.

Configura il progetto di sviluppo

Per configurare il progetto di sviluppo e ottenere una chiave API per il progetto nella console Google Cloud:

  1. Crea un nuovo progetto della console Google Cloud o selezionane uno esistente da utilizzare con l'SDK Driver. Attendi qualche minuto finché il nuovo progetto non è visibile nella console Google Cloud.

  2. Per eseguire l'app demo, il progetto deve avere accesso a Maps SDK per Android. Nella console Google Cloud, seleziona API e servizi > Libreria, poi cerca e attiva Maps SDK per Android.

  3. Ottieni una chiave API per il progetto selezionando API e servizi > Credenziali > Crea credenziali > Chiave API. Per ulteriori informazioni su come ottenere una chiave API, consulta Ottenere una chiave API.

Aggiungi l'SDK Driver alla tua app

L'SDK Driver è disponibile nel Repository Maven di Google. Il repository include i file Project Object Model (.pom) e Javadocs dell'SDK. Per aggiungere l'SDK Driver alla tua app:

  1. Aggiungi la seguente dipendenza alla configurazione Gradle o Maven, sostituendo il segnaposto VERSION_NUMBER per la versione selezionata dell'SDK Driver.

    Gradle

    Aggiungi il seguente codice a build.gradle:

    dependencies {
  ...
  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-driver:[VERSION_NUMBER]'
}

    Maven

    Aggiungi il seguente codice a pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.mapsplatform.transportation.driver</groupId>
    <artifactId>transportation-driver</artifactId>
    <version>[VERSION_NUMBER]</version>
  </dependency>
</dependencies>

  2. L'SDK Driver dipende dall'SDK di navigazione e questa dipendenza è configurata in modo tale che, se è necessaria una versione specifica dell'SDK di navigazione, dovrà essere definita esplicitamente nel file di configurazione della build come riportato di seguito. Se ometti il blocco di codice indicato, il progetto potrà scaricare sempre la versione più recente dell'SDK di navigazione all'interno della versione di release principale. Tieni presente che i comportamenti combinati delle ultime versioni di SDK Driver e SDK di navigazione sono stati sottoposti a test rigorosi prima delle release.

    Organizza di conseguenza la configurazione delle dipendenze del tuo sviluppo e rilascia gli ambienti.

    Gradle

    Aggiungi il seguente codice a build.gradle:

    dependencies {
  ...
  implementation 'com.google.android.libraries.navigation:navigation:5.0.0'
}

    Maven

    Aggiungi il seguente codice a pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>5.0.0</version>
  </dependency>
</dependencies>

Aggiungi la chiave API all'app

Dopo aver aggiunto l'SDK Driver all'app, aggiungi la chiave API all'app. Devi utilizzare la chiave API del progetto che hai ottenuto durante la configurazione del progetto di sviluppo.

Questa sezione descrive come archiviare la chiave API in modo da potervi fare riferimento in modo più sicuro nell'app. Non devi verificare la chiave API nel tuo sistema di controllo della versione. Dovrebbe essere archiviato nel file local.properties, che si trova nella directory radice del progetto. Per ulteriori informazioni sul file local.properties, consulta la pagina relativa ai file delle proprietà di Gradle.

Per semplificare questa attività, utilizza il plug-in Secrets Gradle per Android. Segui questa procedura per installare il plug-in Secrets Gradle e archiviare in modo sicuro la chiave API.

  1. Apri il file build.gradle a livello di directory principale e aggiungi il seguente codice all'elemento dependencies in buildscript.

    Trendy

    buildscript {
    dependencies {
        // ...
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0"
    }
}

    Kotlin

    buildscript {
    dependencies {
        // ...
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.0")
    }
}

  2. Apri il file build.gradle a livello di app e aggiungi il seguente codice all'elemento plugins.

    Trendy

    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'

    Kotlin

    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")

  3. Sincronizza il progetto con Gradle.

  4. Apri local.properties nella directory a livello di progetto, quindi aggiungi il codice seguente. Assicurati di sostituire YOUR_API_KEY con la tua chiave API.

    MAPS_API_KEY=YOUR_API_KEY

  5. Nel file AndroidManifest.xml, vai a com.google.android.geo.API_KEY e aggiorna l'attributo android:value come segue:

    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

L'esempio seguente mostra un manifest completo per un'app di esempio:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.driverapidemo" >
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/_AppTheme" >

        <meta-data
            android:name="com.google.android.geo.API_KEY"
            android:value="${MAPS_API_KEY}" />

        <activity android:name=".MainActivity" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

Includi le attribuzioni richieste nella tua app

Se utilizzi l'SDK Driver nella tua app, devi includere il testo di attribuzione e le licenze open source nella sezione delle note legali dell'app. È meglio includere le attribuzioni come voce di menu indipendente o come parte di una voce di menu Informazioni.

Le informazioni sulle licenze sono disponibili nel file "third_party_licenses.txt" del file AAR non archiviato.

Per informazioni su come includere notifiche open source, consulta la pagina https://developers.google.com/android/guides/opensource.

Dipendenze

L'SDK Driver utilizza gRPC per comunicare con il server Fleet Engine. Se non trasferisci già gRPC, potresti dover dichiarare le seguenti dipendenze:

dependencies {
    implementation 'io.grpc:grpc-android:1.12.0'
    implementation 'io.grpc:grpc-okhttp:1.12.0'
}

Senza queste dipendenze, l'SDK Driver potrebbe riscontrare errori in fase di runtime mentre tenta di comunicare con il server Fleet Engine.

Se utilizzi ProGuard per ottimizzare le build, potresti dover aggiungere le seguenti righe al file di configurazione di ProGuard:

-dontwarn com.google.**
-dontwarn io.grpc.**
-dontwarn okio.**

Il livello API minimo supportato è 23.

Inizializzare l'SDK

Per inizializzare l'oggetto DriverContext è necessario un ID provider (di solito l'ID del progetto Google Cloud). Per ulteriori dettagli sulla configurazione del progetto Google Cloud, consulta Autenticazione e autorizzazione.

Prima di utilizzare Driver SDK, devi inizializzare l'SDK di navigazione. Per inizializzare l'SDK:

  1. Ottieni un oggetto Navigator da NavigationApi.

    NavigationApi.getNavigator(
    this, // Activity
    new NavigationApi.NavigatorListener() {
      @Override
      public void onNavigatorReady(Navigator navigator) {
        // Keep a reference to the Navigator (used to configure and start nav)
        this.navigator = navigator;
      }
    }
);

  2. Crea un oggetto DriverContext e compila i campi obbligatori.

    DriverContext driverContext = DriverContext.builder(application)
    .setProviderId(providerId)
    .setVehicleId(vehicleId)
    .setAuthTokenFactory(authTokenFactory)
    .setNavigator(navigator)
    .setRoadSnappedLocationProvider(
        NavigationApi.getRoadSnappedLocationProvider(application))
    .build();

  3. Utilizza l'oggetto DriverContext per inizializzare *DriverApi.

    DeliveryDriverApi driverApi = DeliveryDriverApi.createInstance(driverContext);

  4. Ottieni DeliveryVehicleReporter dall'oggetto API. (DeliveryVehicleReporter estende NavigationVehicleReporter.)

    DeliveryVehicleReporter vehicleReporter = driverApi.getDeliveryVehicleReporter();

Autenticazione con AuthTokenFactory

Quando l'SDK Driver genera aggiornamenti della posizione, deve inviare questi aggiornamenti al server di Fleet Engine. Per autenticare queste richieste, l'SDK del driver chiama un'istanza fornita dal chiamante di AuthTokenFactory. La fabbrica è responsabile della generazione dei token di autenticazione al momento dell'aggiornamento della località.

La modalità con cui vengono generati i token è specifica per la situazione di ogni sviluppatore. Tuttavia, l'implementazione probabilmente deve:

  • Recuperare un token di autenticazione, possibilmente in formato JSON, da un server HTTPS
  • analizza e memorizza nella cache il token
  • aggiorna il token alla scadenza

Per maggiori dettagli sui token previsti dal server Fleet Engine, consulta Creazione di un token web JSON (JWT) per l'autorizzazione.

Ecco uno schema di implementazione di un AuthTokenFactory:

class JsonAuthTokenFactory implements AuthTokenFactory {
  private String vehicleServiceToken;  // initially null
  private long expiryTimeMs = 0;

  // This method is called on a thread whose only responsibility is to send
  // location updates. Blocking is OK, but just know that no location updates
  // can occur until this method returns.
  @Override
  public String getToken(AuthTokenContext authTokenContext) {
    if (System.currentTimeMillis() > expiryTimeMs) {
      // The token has expired, go get a new one.
      fetchNewToken(vehicleId);
    }
    if (ServiceType.VEHICLE.equals(authTokenContext.getServiceType)) {
      return vehicleServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

  private void fetchNewToken(String vehicleId) {
    String url = "https://yourauthserver.example/token/" + vehicleId;

    try (Reader r = new InputStreamReader(new URL(url).openStream())) {
      com.google.gson.JsonObject obj
          = com.google.gson.JsonParser.parseReader(r).getAsJsonObject();
      vehicleServiceToken = obj.get("VehicleServiceToken").getAsString();
      expiryTimeMs = obj.get("TokenExpiryMs").getAsLong();

      // The expiry time could be an hour from now, but just to try and avoid
      // passing expired tokens, we subtract 10 minutes from that time.
      expiryTimeMs -= 10 * 60 * 1000;
    } catch (IOException e) {
      // It's OK to throw exceptions here. The StatusListener you passed to
      // create the DriverContext class will be notified and passed along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}

Questa particolare implementazione utilizza il client HTTP Java integrato per recuperare un token in formato JSON dal server di autenticazione dello sviluppatore. Il token viene salvato per il riutilizzo. Il token viene recuperato se precedente entro 10 minuti dalla data di scadenza.

La tua implementazione potrebbe fare le cose in modo diverso, ad esempio utilizzare un thread in background per aggiornare i token.

Le eccezioni in AuthTokenFactory vengono trattate come temporanee, a meno che non si verifichino ripetute. Dopo una serie di tentativi, l'SDK driver presuppone che l'errore sia permanente e smette di tentare di inviare aggiornamenti.

Segnalazione di stato ed errori con StatusListener

Poiché l'SDK Driver esegue azioni in background, utilizza StatusListener per attivare notifiche quando si verificano determinati eventi, come errori, avvisi o messaggi di debug. Gli errori possono essere di natura temporanea (ad esempio BACKEND_CONNECTIVITY_ERROR) o comportare l'interruzione definitiva degli aggiornamenti della posizione (ad esempio VEHICLE_NOT_FOUND, che indica un errore di configurazione).

Fornisci un'implementazione facoltativa di tipo StatusListener, come la seguente:

class MyStatusListener implements StatusListener {
  /** Called when background status is updated, during actions such as location reporting. */
  @Override
  public void updateStatus(
      StatusLevel statusLevel, StatusCode statusCode, String statusMsg) {
    // Status handling stuff goes here.
    // StatusLevel may be DEBUG, INFO, WARNING, or ERROR.
    // StatusCode may be DEFAULT, UNKNOWN_ERROR, VEHICLE_NOT_FOUND,
    // BACKEND_CONNECTIVITY_ERROR, or PERMISSION_DENIED.
  }
}

Note su SSL/TLS

Internamente, l'implementazione dell'SDK Driver utilizza SSL/TLS per comunicare in modo sicuro con il server Fleet Engine. Le versioni precedenti di Android (API 23 o versioni precedenti) potrebbero richiedere una patch SecurityProvider per comunicare con il server. Per ulteriori informazioni sull'utilizzo di SSL in Android, vedi Provider di sicurezza GMS. L'articolo contiene anche esempi di codice per l'applicazione di patch al provider di sicurezza.

Attiva aggiornamenti posizione

Dopo aver creato un'istanza *VehicleReporter, abilitare gli aggiornamenti della località è semplice:

DeliveryVehicleReporter reporter = ...;

reporter.enableLocationTracking();

Se possibile, gli aggiornamenti della posizione vengono inviati a intervalli regolari. Ogni aggiornamento della posizione indica anche che il veicolo è online.

Per impostazione predefinita, l'intervallo del report è di 10 secondi. Puoi modificare l'intervallo di report con reporter.setLocationReportingInterval(long, TimeUnit). L'intervallo di aggiornamento minimo supportato è di 5 secondi. Aggiornamenti più frequenti possono causare richieste ed errori più lenti.

Disattivare gli aggiornamenti della posizione

Al termine del turno del conducente, puoi interrompere gli aggiornamenti sulla posizione chiamando il numero DeliveryVehicleReporter.disableLocationTracking.

Casi d'uso di modelli attendibili

Questa sezione descrive come utilizzare l'SDK Driver per implementare casi d'uso comuni quando si utilizza il modello attendibile.

Crea un veicolo

Puoi creare un veicolo dall'SDK Driver.

Prima di creare un veicolo, assicurati di inizializzare l'API Delivery Driver. L'ID veicolo deve essere creato con l'ID veicolo e provider utilizzati durante l'inizializzazione dell'SDK driver. Quindi crea il veicolo come mostrato nell'esempio seguente:

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleManager vehicleManager = api.getDeliveryVehicleManager();
try {
  DeliveryVehicle vehicle = vehicleManager.createVehicle().get();
  // Handle CreateVehicleRequest DeliveryVehicle response.
} catch (Exception e) {
  // Handle CreateVehicleRequest error.
}

Crea un'attività di ritiro della spedizione

Puoi creare un'attività di ritiro della spedizione dall'SDK Driver.

Prima di creare un'attività, assicurati di inizializzare l'API Delivery Driver. L'attività deve essere creata utilizzando l'ID provider specificato durante l'inizializzazione dell'SDK driver. Poi crea l'attività di ritiro della spedizione come mostrato nell'esempio seguente. Per informazioni sugli ID attività, consulta Esempi di ID attività.

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
   .setTaskDurationSeconds(2 * 60)
   .setParentId("my-tracking-id")
   .setTaskType(TaskType.DELIVERY_PICKUP)
   .build();

try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

Creare un'attività di consegna della spedizione

Puoi creare un'attività di consegna della spedizione dall'SDK Driver.

Prima di creare un'attività, assicurati di inizializzare l'API Delivery Driver. Quindi crea l'attività di consegna della spedizione come mostrato nell'esempio seguente. Per informazioni sugli ID attività, consulta Esempi di ID attività.

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
   .setTaskDurationSeconds(2 * 60)
   .setParentId("my-tracking-id")
   .setTaskType(TaskType.DELIVERY_DELIVERY)
   .build();
try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

Indisponibilità pianificata

Puoi creare un'attività che indica l'indisponibilità (ad esempio, per interruzioni del conducente o rifornimento di veicoli) dall'SDK Driver. Un'attività di indisponibilità pianificata non deve includere un ID monitoraggio. Se vuoi, puoi fornire una località.

Prima di creare un'attività, assicurati di inizializzare l'API Delivery Driver. Quindi, crea l'attività di indisponibilità come mostrato nell'esempio seguente. Per informazioni sugli ID attività, consulta Esempi di ID attività.

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setTaskDurationSeconds(2 * 60) // Duration or location (or both) must be provided for a BREAK task.
   .setTaskType(TaskType.UNAVAILABLE)
   .build();
try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

Fermate programmate

Puoi creare un'attività di interruzione pianificata tramite l'SDK Driver. Un'attività di interruzione pianificata potrebbe non includere un ID monitoraggio.

Prima di creare un'attività, assicurati di inizializzare l'API Delivery Driver. Quindi crea l'attività di interruzione pianificata come mostrato nell'esempio seguente. Per informazioni sugli ID attività, consulta Esempi di ID attività.

    static final String TASK_ID = "task-8241890"; //  Avoid auto-incrementing IDs.

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
    CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
       .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
       .setTaskDurationSeconds(2 * 60)
       .setTaskType(TaskType.DELIVERY_SCHEDULED_STOP)
       .build();
    try {
       DeliveryTask task = taskManager.createTask(request).get();
       // Handle CreateTaskRequest DeliveryTask response.
    } catch (Exception e)  {
       // Handle CreateTaskRequest error.
    }

Aggiorna l'ordine delle attività

Puoi aggiornare l'ordine di esecuzione delle attività assegnate a un veicolo dall'SDK Driver.

L'aggiornamento dell'ordine delle attività assegna anche attività a un veicolo se non erano precedentemente assegnate a un veicolo. Chiude anche le attività che in precedenza erano assegnate a un veicolo e che sono state escluse dall'ordine aggiornato. L'assegnazione di un'attività a un veicolo diverso, se precedentemente assegnata a un altro veicolo, genera un errore. Prima di assegnare un'attività al nuovo veicolo, chiudi l'attività esistente e creane una nuova.

Puoi aggiornare l'ordine delle attività in qualsiasi momento.

Prima di aggiornare l'ordine delle attività per un veicolo, assicurati che il veicolo e le attività siano già stati creati in Fleet Engine. Poi aggiorna l'ordine delle attività per il veicolo come mostrato nell'esempio seguente.

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
    try {
       List<VehicleStop> stops = reporter.setVehicleStops(
         ImmutableList.of(
             VehicleStop.builder()
                 .setVehicleStopState(VehicleStopState.ARRIVED)
                 .setWaypoint(Waypoint.builder().setLatLng(37.1749, 122.412).build())
                 .setTasks(ImmutableList.of(task1)) // Previously created DeliveryTask in Fleet Engine.
                 .build(),
             VehicleStop.builder()
                 .setVehicleStopState(VehicleStopState.NEW) // The current vehicle stop.
                 .setWaypoint(Waypoint.builder().setLatLng(37.7749, 122.4194).build())
                 .setTasks(ImmutableList.of(task2)) // Previously created DeliveryTask in Fleet Engine.
                 .build(),
             VehicleStop.builder()
                 .setVehicleStopState(VehicleStopState.NEW)
                 .setWaypoint(Waypoint.builder().setLatLng(37.3382, 121.8863).build())
                 .setTasks(ImmutableList.of(task3, task4)) // Previously created DeliveryTasks in Fleet Engine.
                 .build())).get();
       // Successfully updated vehicle stops in Fleet Engine. Returns the successfully set VehicleStops.
    } catch (Exception e)  {
       // Failed to update vehicle stops in Fleet Engine. Setting VehicleStops must be attempted again after resolving
       // errors.
    }

Potrebbe verificarsi un'eccezione che potrebbe impedire un aggiornamento dello stato interno dell'SDK del driver. In questo caso, risolvi il problema e chiama nuovamente setVehicleStops finché la chiamata non va a buon fine.

I potenziali problemi possono includere:

  • I VehicleStop specificati non seguono un pattern valido. Solo il primo VeicoloStop può essere in uno qualsiasi dei VeicoloStopState: NEW, ENROUTE o ARRIVED. Il valore VehicleStops dopo l'arresto attuale deve essere nel NUOVO VehicleStopState.

  • Le attività non esistono o appartengono a un altro veicolo.

  • Il veicolo non esiste.

Il veicolo è in viaggio verso la prossima fermata

Fleet Engine deve essere avvisata quando un veicolo parte da una fermata e quando inizia la navigazione. Puoi inviare una notifica a Fleet Engine dall'SDK Driver.

Prima di comunicare a Fleet Engine che un veicolo è partito da una fermata, assicurati di aver creato e impostato le fermate del veicolo. Quindi, comunica a Fleet Engine la partenza del veicolo come mostrato nell'esempio seguente.

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
    reporter.enableLocationTracking(); // Location tracking must be enabled.

    // Create Vehicle, VehicleStops, and DeliveryTasks.
    // Set VehicleStops on Vehicle.

    navigator.setDestination(vehicleStop.getWaypoint());
    try {
       List<VehicleStop> updatedStops = reporter.enrouteToNextStop().get();
       // Successfully updated vehicle stops in Fleet Engine. Returns the set VehicleStops, with the first
       // VehicleStop updated to ENROUTE state.
    } catch (Exception e)  {
       // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
       // after resolving errors.
    }

Potrebbe verificarsi un'eccezione che potrebbe impedire un aggiornamento dello stato interno dell'SDK del driver. In questo caso, risolvi il problema e chiama di nuovo enrouteToNextStop finché l'operazione non viene completata correttamente.

I potenziali problemi possono includere:

  • Nessun elemento VehicleStops rimanente impostato nell'SDK Driver.

Il veicolo arriva a una fermata

Fleet Engine deve essere avvisata quando un veicolo arriva a una fermata. Puoi inviare una notifica a Fleet Engine dall'SDK Driver.

Prima di comunicare a Fleet Engine che un veicolo è arrivato a una fermata, assicurati che il veicolo si fermi. Quindi, comunica a Fleet Engine l'arrivo del veicolo alla fermata, come illustrato nell'esempio seguente.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
reporter.enableLocationTracking(); // Location tracking must be enabled.

// Create Vehicle, VehicleStops, and DeliveryTasks.
// Set VehicleStops on Vehicle.
// Mark ENROUTE to VehicleStop and start guidance using Navigator.

try {
   List<VehicleStop> updatedStopsArrived = reporter.arrivedAtStop().get();
   // Successfully updated vehicle stops in Fleet Engine. Returns the set VehicleStops, with the first
   // VehicleStop updated to ARRIVED state.
   navigator.clearDestinations();
} catch (Exception e)  {
   // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
   // after resolving errors.
}

Può verificarsi un'eccezione che potrebbe impedire un aggiornamento dello stato interno dell'SDK del driver. In questo caso, risolvi il problema e chiama di nuovo arrivedAtStop finché non va a buon fine.

I potenziali problemi potrebbero includere:

  • Nessun elemento VehicleStops rimanente impostato nell'SDK Driver.

Il veicolo completa una fermata

Devi informare Fleet Engine quando un veicolo si ferma. Con questa notifica, tutte le attività associate alla fermata vengono impostate su uno stato CHIUSO. Puoi inviare una notifica a Fleet Engine dall'SDK Driver.

Comunica a Fleet Engine che il veicolo ha completato il proprio veicoloStop, come mostrato nell'esempio seguente.

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
    reporter.enableLocationTracking(); // Location tracking must be enabled.

    // After completing the tasks at the VehicleStop, remove it from the
    // the current list of VehicleStops.

    try {
       List<VehicleStop> updatedStopsCompleted = reporter.completedStop().get();
       // Successfully updated vehicle stops in Fleet Engine. All tasks on the completed stop are set to CLOSED.
       // Returns the set VehicleStops, with the completed VehicleStop removed from the remaining list.
    } catch (Exception e)  {
       // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
       // after resolving errors.
    }

Può verificarsi un'eccezione che potrebbe impedire un aggiornamento dello stato interno dell'SDK del driver. In questo caso, risolvi il problema e chiama di nuovo completedStop finché non va a buon fine.

I potenziali problemi possono includere:

  • Nessun elemento VehicleStops rimanente impostato nell'SDK Driver.

Chiudere un'attività

Per chiudere un'attività assegnata a un veicolo, comunica a Fleet Engine che il veicolo ha completato la fermata in cui si svolge l'attività oppure rimuovilo dall'elenco delle fermate del veicolo. Per farlo, puoi impostare l'elenco delle fermate rimanenti dei veicoli proprio come aggiornando l'ordine delle attività per un veicolo.

Se un'attività non è ancora stata assegnata a un veicolo e deve essere chiusa, aggiorna l'attività impostandola su CHIUSA. Tuttavia, non puoi riaprire un'attività CHIUSA.

La chiusura di un'attività non indica se l'attività è riuscita o meno. Indica che l'attività non è più in corso. Per il monitoraggio della spedizione, è importante indicare il risultato effettivo di un'attività in modo da poter mostrare l'esito della consegna.

Un'attività deve essere assegnata a un veicolo per poter utilizzare l'SDK Driver per chiuderla. Per chiudere un'attività assegnata a un veicolo, informa Fleet Engine che il veicolo ha completato l'arresto in cui si svolge l'attività.

In alternativa, aggiorna l'ordine delle attività del veicolo a cui è assegnata l'attività, quindi rimuovi l'attività dall'elenco degli scali.

Imposta l'esito dell'attività e la località dei risultati

La chiusura di un'attività non indica se l'attività è riuscita o meno. Indica che l'attività non è più in corso. Per il monitoraggio della spedizione, è importante indicare il risultato effettivo di un'attività in modo da poter visualizzare l'esito della consegna e garantire la fatturazione corretta per i servizi. Una volta impostata, non puoi modificare il risultato dell'attività. ma puoi modificare l'ora e la località dei risultati delle attività dopo averle impostate.

Il risultato delle attività in stato CHIUSO può essere impostato su SUCCEEDED o FAILED. Fleet Engine addebita solo le attività di consegna con lo stato SUCCEEDED.

Quando contrassegna il risultato di un'attività, Fleet Engine compila automaticamente la posizione dei risultati dell'attività con l'ultima posizione nota del veicolo. Puoi ignorare questo comportamento.

L'esempio seguente mostra come utilizzare l'SDK Driver per impostare un risultato e un timestamp per un'attività. Non puoi impostare la località dei risultati delle attività utilizzando l'SDK Driver.

    static final String TASK_ID = "task-8241890";

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryTaskManager taskManager = api.getDeliveryTaskManager();

    // Updating an existing DeliveryTask which is already CLOSED. Manually
    // setting TaskOutcomeLocation with Driver SDK is not supported at this time.
    UpdateDeliveryTaskRequest req = UpdateDeliveryTaskRequest.builder(TASK_ID)
        .setTaskOutcome(TaskOutcome.SUCCEEDED)
        .setTaskOutcomeTimestamp(now()) // Timestamp in milliseconds.
        .build();

    try {
       DeliveryTask updatedTask = taskManager.updateTask(req);
       // Handle UpdateTaskRequest DeliveryTask response.
    } catch (Exception e)  {
       // Handle UpdateTaskRequest error.
    }

Cerca un veicolo

Puoi cercare un veicolo dall'SDK Driver. Prima di cercare un veicolo, assicurati di inizializzare l'API Delivery Driver. Puoi quindi cercare il veicolo come mostrato nell'esempio seguente.

    DeliveryDriverApi api = DeliveryDriverApi.getInstance();
    DeliveryVehicleManager vehicleManager = api.getDeliveryVehicleManager();
    try {
       DeliveryVehicle vehicle = vehicleManager.getVehicle().get();
       // Handle GetVehicleRequest DeliveryVehicle response.
    } catch (Exception e)  {
       // Handle GetVehicleRequest error.
    }

DeliveryVehicleManager può cercare nel DeliveryVehicle solo l'ID veicolo fornito durante l'inizializzazione dell'API Delivery Driver.