Wenn Sie einer Fahrt folgen, wird dem Nutzer in Ihrer Consumer-App der Standort des entsprechenden Fahrzeugs angezeigt. Dazu muss Ihre App eine Fahrt starten, den Fortschritt der Fahrt aktualisieren und die Fahrt beenden, wenn sie abgeschlossen ist.
In diesem Dokument wird beschrieben, wie dieser Prozess funktioniert.
Hinweis
Achten Sie darauf, dass Sie Folgendes eingerichtet haben:
Die Backend-Dienste für Ihre Verbraucher-App sind eingerichtet und Ihre Dienste für die Zuordnung von Verbrauchern zu Fahrzeugen sind betriebsbereit.
Sie haben eine Karte für Ihre App eingerichtet.
Einer Reise folgen
Wenn Ihr Backend-Server einem Nutzer ein Fahrzeug zuweist, verwenden Sie JourneySharingSession
, um die Fahrt zu verfolgen.
Der folgende Beispielcode zeigt, wie Sie nach dem Laden der Ansicht mit der Verfolgung 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()
}
}
Streckenfortschritt aktualisieren
Wenn Sie Details zum Fortschritt der Fahrt aktualisieren möchten, z. B. die Entfernung, die das Fahrzeug vor der Ankunft noch zurücklegen muss, und die voraussichtliche 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)
Einer Reise nicht mehr folgen
Achten Sie darauf, dass Ihre App die Fahrt beendet, wenn sie nicht mehr benötigt wird, z. B. wenn die Fahrt vom Fahrer im Backend als ABGESCHLOSSEN markiert wird. Durch das Beenden der Routenfreigabe werden unnötige Netzwerkanfragen an Fleet Engine vermieden und Speicherlecks verhindert.
Verwenden Sie JourneySharingSession
, um die Routenführung zu 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()
}
}
Fehler bei Fahrten beheben
Die Methode onTripRefreshError
gibt Fehler zurück, die während der Fahrtüberwachung auftreten. Fehlermeldungen entsprechen dem Google Cloud-Fehlerstandard. Detaillierte Definitionen von Fehlermeldungen und alle Fehlercodes finden Sie in der Google Cloud-Dokumentation zu Fehlern.
Im Folgenden finden Sie einige häufige Fehler, die während der Fahrtenaufzeichnung auftreten können:
HTTP | RPC | Beschreibung |
---|---|---|
400 | INVALID_ARGUMENT | Der Client hat einen ungültigen Namen für die Reise angegeben. Der Name der Reise muss dem Format providers/{provider_id}/trips/{trip_id} entsprechen. Die provider_id muss die ID des Cloud-Projekts sein, das dem Dienstanbieter gehört. |
401 | NICHT AUTHENTIFIZIERT | Dieser Fehler wird angezeigt, wenn keine gültigen Anmeldedaten vorhanden sind. Das kann beispielsweise der Fall sein, wenn das JWT-Token ohne eine Fahrt-ID signiert wurde oder das JWT-Token abgelaufen ist. |
403 | PERMISSION_DENIED | Dieser Fehler tritt auf, wenn der Client nicht die erforderlichen Berechtigungen hat (z. B. wenn ein Nutzer mit der Rolle „Consumer“ versucht, „updateTrip“ aufzurufen), wenn das JWT-Token ungültig ist oder wenn die API nicht für das Clientprojekt 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 null oder die Trafficrate ü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 beheben
Das Consumer SDK sendet Fehler bei der Aktualisierung von Fahrten über einen Callback-Mechanismus an die Consumer-App. Der Callback-Parameter ist ein plattformspezifischer Rückgabetyp (TripUpdateError
unter Android und NSError
unter iOS).
Statuscodes extrahieren
Die an den Callback ü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
Sie können einen gRPC-Statuscode extrahieren, der Details zum Fehler enthält, der von onTripUpdateError()
zurückgegebenen TripUpdateError
.
// Called when there is a trip update error.
@Override
public void onTripUpdateError(TripInfo tripInfo, TripUpdateError error) {
Status.Code code = error.getStatusCode();
}
Kotlin
Sie können einen gRPC-Statuscode extrahieren, der Details zum Fehler enthält, der von onTripUpdateError()
zurückgegebenen TripUpdateError
.
// Called when there is a trip update error.
override fun onTripUpdateError(tripInfo: TripInfo, error: TripUpdateError) {
val code = error.getStatusCode()
}
Statuscodes interpretieren
Statuscodes decken zwei Arten von Fehlern ab: Server- und Netzwerkfehler sowie clientseitige Fehler.
Server- und Netzwerkfehler
Die folgenden Statuscodes weisen auf Netzwerk- oder Serverfehler hin. Sie müssen nichts unternehmen, um diese Fehler zu beheben. Das Consumer SDK kann solche Fehler automatisch beheben.
Statuscode | Beschreibung |
---|---|
ABORTED | Der Server hat das Senden der Antwort beendet. Das liegt normalerweise an einem Serverproblem. |
CANCELLED | Der Server hat die ausgehende Antwort beendet. Das passiert normalerweise, wenn
die App in den Hintergrund verschoben wird oder sich der Status in der Consumer-App ändert. |
INTERRUPTED | |
DEADLINE_EXCEEDED | Der Server hat zu lange zum Antworten gebraucht. |
UNAVAILABLE | Der Server war nicht verfügbar. Dies ist normalerweise auf ein Netzwerkproblem zurückzuführen. |
Clientfehler
Die folgenden Statuscodes beziehen sich auf Clientfehler. Sie müssen Maßnahmen ergreifen, um diese zu beheben. Das Consumer SDK versucht weiterhin, die Fahrt zu aktualisieren, bis Sie die Fahrtfreigabe beenden. Es kann jedoch erst wieder funktionieren, wenn Sie Maßnahmen ergreifen.
Statuscode | Beschreibung |
---|---|
INVALID_ARGUMENT | In der Consumer-App wurde ein ungültiger Fahrtenname angegeben. Der Fahrtenname muss dem Format providers/{provider_id}/trips/{trip_id} entsprechen.
|
NOT_FOUND | Die Reise wurde nie erstellt. |
PERMISSION_DENIED | Die Consumer-App hat nicht die erforderlichen Berechtigungen. Dieser Fehler tritt in folgenden Fällen auf:
|
RESOURCE_EXHAUSTED | Das Ressourcenkontingent ist null oder die Rate des Traffics überschreitet das Tempolimit. |
NICHT AUTHENTIFIZIERT | Die Anfrage konnte aufgrund eines ungültigen JWT-Tokens nicht authentifiziert werden. Dieser Fehler tritt auf, wenn das JWT-Token ohne eine Fahrt-ID signiert wurde oder wenn das JWT-Token abgelaufen ist. |