Wenn Sie einen Fahrtenverlauf verfolgen, wird in Ihrer App für den Nutzer der Standort des entsprechenden Fahrzeugs angezeigt. Dazu muss Ihre App eine Fahrt verfolgen, den Fahrtfortschritt aktualisieren und die Fahrt beenden, wenn sie abgeschlossen ist.
In diesem Dokument wird beschrieben, wie dieser Prozess funktioniert.
Hinweis
Sie müssen Folgendes eingerichtet haben:
Die Back-End-Dienste für Ihre Verbraucher-App sind vorhanden und Ihre Dienste zur Zuordnung von Nutzern zu Fahrzeugen sind einsatzbereit.
Sie haben eine Karte für Ihre App eingerichtet.
Einem Trip folgen
Wenn Ihr Backend-Server einen Nutzer einem Fahrzeug zuordnet, verwenden Sie JourneySharingSession
, um die Fahrt zu verfolgen.
Im folgenden Beispielcode wird gezeigt, wie Sie nach dem Laden der Ansicht mit dem Folgen einer Fahrt beginnen.
Java
public class MainActivity extends AppCompatActivity
implements ConsumerViewModel.JourneySharingListener {
// Class implementation
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Create a TripModel instance to listen for updates to the trip specified by this trip name.
String tripName = ...;
TripModelManager tripModelManager = consumerApi.getTripModelManager();
TripModel tripModel = tripModelManager.getTripModel(tripName);
// Create a JourneySharingSession instance based on the TripModel.
JourneySharingSession session = JourneySharingSession.createInstance(tripModel);
// Add the JourneySharingSession instance on the map for updating the UI.
consumerController.showSession(session);
// Register for trip update events.
tripModel.registerTripCallback(new TripModelCallback() {
@Override
public void onTripETAToNextWaypointUpdated(
TripInfo tripInfo, @Nullable Long timestampMillis) {
// ...
}
@Override
public void onTripActiveRouteRemainingDistanceUpdated(
TripInfo tripInfo, @Nullable Integer distanceMeters) {
// ...
}
// ...
});
}
@Override
protected void onDestroy() {
super.onDestroy();
if (journeySharingSession != null) {
journeySharingSession.stop();
}
}
}
Kotlin
class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {
// Class implementation
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// Create a TripModel instance to listen for updates to the trip specified by this trip name.
val tripName = "tripName"
val tripModelManager = consumerApi.getTripModelManager()
val tripModel = tripModelManager.getTripModel(tripName)
// Create a JourneySharingSession instance based on the TripModel.
val session = JourneySharingSession.createInstance(tripModel)
// Add the JourneySharingSession instance on the map for updating the UI.
consumerController.showSession(session)
// Register for trip update events.
tripModel.registerTripCallback(
object : TripModelCallback() {
override fun onTripETAToNextWaypointUpdated(
tripInfo: TripInfo,
timestampMillis: Long?,
) {
// ...
}
override fun onTripActiveRouteRemainingDistanceUpdated(
tripInfo: TripInfo,
distanceMeters: Int?,
) {
// ...
}
// ...
})
}
override fun onDestroy() {
super.onDestroy()
journeySharingSession?.stop()
}
}
Fahrtfortschritt aktualisieren
Wenn Sie Details zum Fahrtverlauf aktualisieren möchten, z. B. die Strecke, die das Fahrzeug bis zur Ankunft zurücklegen muss, und die geschätzte Ankunftszeit, muss Ihre App einen Listener registrieren und konfigurieren, wie in den folgenden Beispielen gezeigt.
Registrieren Sie einen Listener für ein
TripModel
-Objekt.Java
// Create a TripModel instance for listening to updates to the trip specified by this trip name. String tripName = ...; TripModelManager tripModelManager = consumerApi.getTripModelManager(); TripModel tripModel = tripModelManager.getTripModel(tripName); // Create a JourneySharingSession instance based on the TripModel. JourneySharingSession session = JourneySharingSession.createInstance(tripModel); // Add the JourneySharingSession instance on the map for updating the UI. consumerController.showSession(session); // Register for trip update events. tripModel.registerTripCallback(new TripModelCallback() { @Override public void onTripETAToNextWaypointUpdated( TripInfo tripInfo, @Nullable Long timestampMillis) { // ... } @Override public void onTripActiveRouteRemainingDistanceUpdated( TripInfo tripInfo, @Nullable Integer distanceMeters) { // ... } // ... });
Kotlin
// Create a TripModel instance for listening to updates to the trip specified by this trip name. val tripName = "tripName" val tripModelManager = consumerApi.getTripModelManager() val tripModel = tripModelManager.getTripModel(tripName) // Create a JourneySharingSession instance based on the TripModel. val session = JourneySharingSession.createInstance(tripModel) // Add the JourneySharingSession instance on the map for updating the UI. consumerController.showSession(session) // Register for trip update events. tripModel.registerTripCallback( object : TripModelCallback() { override fun onTripETAToNextWaypointUpdated( tripInfo: TripInfo, timestampMillis: Long?, ) { // ... } override fun onTripActiveRouteRemainingDistanceUpdated( tripInfo: TripInfo, distanceMeters: Int?, ) { // ... } // ... })
Konfigurieren Sie den Listener für Ihre Fahrt mit
TripModelOptions
.Java
// Set refresh interval to 2 seconds. TripModelOptions tripOptions = TripModelOptions.builder().setRefreshIntervalMillis(2000).build(); tripModel.setTripModelOptions(tripOptions);
Kotlin
// Set refresh interval to 2 seconds. val tripOptions = TripModelOptions.builder().setRefreshIntervalMillis(2000).build() tripModel.setTripModelOptions(tripOptions)
Reise nicht mehr verfolgen
Ihre App darf eine Fahrt nicht mehr verfolgen, wenn sie nicht mehr benötigt wird, z. B. wenn die Fahrt vom Fahrer im Back-End als ABGESCHLOSSEN markiert wurde. Wenn Sie die Fahrtenfreigabe beenden, werden unnötige Netzwerkanfragen an die Fleet Engine vermieden und Arbeitsspeicherlecks verhindert.
Mit JourneySharingSession
können Sie die Fahrt beenden, wie im folgenden Beispielcode gezeigt.
Java
public class MainActivity extends AppCompatActivity
implements ConsumerViewModel.JourneySharingListener {
// Class implementation
@Override
protected void onDestroy() {
super.onDestroy();
if (journeySharingSession != null) {
journeySharingSession.stop();
}
}
}
Kotlin
class SampleAppActivity : AppCompatActivity(), ConsumerViewModel.JourneySharingListener {
// Class implementation
override fun onDestroy() {
super.onDestroy()
journeySharingSession?.stop()
}
}
Fahrtfehler behandeln
Mit der Methode onTripRefreshError
werden Fehler angezeigt, die während der Fahrtüberwachung auftreten. Fehlermeldungen folgen dem Google Cloud-Fehlerstandard. Ausführliche Definitionen von Fehlermeldungen und alle Fehlercodes finden Sie in der Google Cloud-Dokumentation zu Fehlern.
Im Folgenden sind einige häufige Fehler aufgeführt, die beim Überwachen von Fahrten auftreten können:
HTTP | RPC | Beschreibung |
---|---|---|
400 | INVALID_ARGUMENT | Der Kunde hat einen ungültigen Fahrtnamen angegeben. Der Name der Fahrt muss das Format providers/{provider_id}/trips/{trip_id} haben. Die provider_id muss die ID des Cloud-Projekts sein, das dem Dienstanbieter gehört. |
401 | UNAUTHENTICATED | Dieser Fehler wird angezeigt, wenn keine gültigen Anmeldedaten vorhanden sind. Das ist beispielsweise der Fall, wenn das JWT-Token ohne Fahrten-ID signiert ist oder abgelaufen ist. |
403 | PERMISSION_DENIED | Dieser Fehler tritt auf, wenn der Client nicht über ausreichende Berechtigungen verfügt (z. B. wenn ein Nutzer mit der Rolle „Verbraucher“ versucht, updateTrip aufzurufen), das JWT-Token ungültig ist oder die API für das Clientprojekt nicht aktiviert ist. Das JWT-Token fehlt möglicherweise oder das Token ist mit einer Fahrt-ID signiert, die nicht mit der angeforderten Fahrt-ID übereinstimmt. |
429 | RESOURCE_EXHAUSTED | Das Ressourcenkontingent ist auf null oder die Zugriffsrate überschreitet das Limit. |
503 | UNAVAILABLE | Dienst nicht verfügbar: In der Regel ist der Server ausgefallen. |
504 | DEADLINE_EXCEEDED | Die Frist der Anfrage wurde überschritten. Dieser Fehler tritt nur auf, wenn für den Aufruf eine Frist festgelegt wurde, die kürzer ist als die Standardfrist der Methode (d. h., die angeforderte Frist reicht nicht aus, damit der Server die Anfrage bearbeitet), und die Anfrage nicht innerhalb der Frist abgeschlossen wurde. |
Consumer SDK-Fehler behandeln
Das Consumer SDK sendet Fehler bei Fahrtupdates über einen Rückrufmechanismus an die Verbraucher-App. Der Callback-Parameter ist ein plattformspezifischer Rückgabetyp (TripUpdateError
unter Android und NSError
unter iOS).
Statuscodes extrahieren
Die an den Rückruf übergebenen Fehler sind in der Regel gRPC-Fehler. Sie können auch zusätzliche Informationen in Form eines Statuscodes daraus extrahieren. Eine vollständige Liste der Statuscodes finden Sie unter Statuscodes und ihre Verwendung in gRPC.
Java
Du kannst einen gRPC-Statuscode mit Details zum Fehler aus dem von onTripUpdateError()
zurückgegebenen TripUpdateError
extrahieren.
// Called when there is a trip update error.
@Override
public void onTripUpdateError(TripInfo tripInfo, TripUpdateError error) {
Status.Code code = error.getStatusCode();
}
Kotlin
Du kannst einen gRPC-Statuscode mit Details zum Fehler aus dem von onTripUpdateError()
zurückgegebenen TripUpdateError
extrahieren.
// Called when there is a trip update error.
override fun onTripUpdateError(tripInfo: TripInfo, error: TripUpdateError) {
val code = error.getStatusCode()
}
Statuscodes interpretieren
Statuscodes umfassen zwei Arten von Fehlern: server- und netzwerkbezogene Fehler sowie clientseitige Fehler.
Server- und Netzwerkfehler
Die folgenden Statuscodes beziehen sich auf Netzwerk- oder Serverfehler. Sie müssen nichts unternehmen, um sie zu beheben. Das Consumer SDK stellt sich automatisch wieder her.
Statuscode | Beschreibung |
---|---|
ABORTED | Der Server sendet die Antwort nicht mehr. In der Regel liegt ein Serverproblem vor. |
CANCELLED | Der Server hat die ausgehende Antwort beendet. Das geschieht normalerweise, wenn die App in den Hintergrund verschoben wird oder sich der Status in der -Kunden-App ändert. |
INTERRUPTED | |
DEADLINE_EXCEEDED | Die Antwort des Servers hat zu lange gedauert. |
UNAVAILABLE | Der Server war nicht verfügbar. Dies ist in der Regel auf ein Netzwerkproblem zurückzuführen. |
Clientfehler
Die folgenden Statuscodes beziehen sich auf Clientfehler. Sie müssen Maßnahmen ergreifen, um sie zu beheben. Das Consumer SDK versucht weiterhin, die Fahrt zu aktualisieren, bis Sie die Fahrtfreigabe beenden. Die Fahrt wird jedoch erst wiederhergestellt, wenn Sie eine Maßnahme ergreifen.
Statuscode | Beschreibung |
---|---|
INVALID_ARGUMENT | In der Verbraucher-App wurde ein ungültiger Fahrtname angegeben. Der Fahrtname muss dem Format providers/{provider_id}/trips/{trip_id} entsprechen.
|
NOT_FOUND | Die Fahrt wurde nie erstellt. |
PERMISSION_DENIED | Die Verbraucher-App hat nicht genügend Berechtigungen. Dieser Fehler tritt in folgenden Fällen auf:
|
RESOURCE_EXHAUSTED | Das Ressourcenkontingent ist auf null gesetzt oder die Datenübertragungsrate überschreitet das Geschwindigkeitslimit. |
UNAUTHENTICATED | Die Authentifizierung der Anfrage ist aufgrund eines ungültigen JWT-Tokens fehlgeschlagen. Dieser Fehler tritt entweder auf, wenn das JWT-Token ohne Fahrt-ID signiert ist, oder wenn das JWT-Token abgelaufen ist. |