Wenn Sie eine Fahrt verfolgen, wird dem Nutzer in Ihrer Consumer-App der Standort des entsprechenden Fahrzeugs angezeigt. Dazu muss Ihre App eine Fahrt verfolgen, den Fortschritt der Fahrt aktualisieren und die Verfolgung beenden, wenn die Fahrt abgeschlossen ist.
In diesem Dokument wird beschrieben, wie dieser Prozess funktioniert.
Hinweis
Achten Sie darauf, dass Sie Folgendes eingerichtet haben:
Die Back-End-Dienste für Ihre Consumer-App sind eingerichtet und Ihre Dienste zum Abgleichen von Nutzern mit Fahrzeugen sind betriebsbereit.
Sie haben eine Karte eingerichtet für Ihre App.
Fahrt verfolgen
Wenn Ihr Back-End-Server einen Nutzer mit einem Fahrzeug abgleicht, verwenden Sie JourneySharingSession, um die Fahrt zu verfolgen.
Der folgende Beispielcode zeigt, wie Sie eine Fahrt verfolgen, nachdem die Ansicht geladen wurde.
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()
}
}
Fortschritt der Fahrt aktualisieren
Wenn Sie Details zum Fortschritt der Fahrt aktualisieren möchten, z. B. die Entfernung, die das Fahrzeug vor der Ankunft 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)
Fahrt nicht mehr verfolgen
Achten Sie darauf, dass Ihre App die Verfolgung einer Fahrt beendet, wenn sie nicht mehr benötigt wird, z. B. wenn die Fahrt vom Fahrer im Back-End als ABGESCHLOSSEN markiert wird. Wenn Sie die gemeinsame Nutzung von Fahrten beenden, werden unnötige Netzwerkanfragen an Fleet Engine vermieden und Speicherlecks verhindert.
Verwenden Sie JourneySharingSession, um die Verfolgung der Fahrt 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 behandeln
Die Methode onTripRefreshError gibt Fehler aus, die bei der Fahrtüberwachung auftreten. Fehlermeldungen folgen dem Google Cloud-Fehlerstandard. Detaillierte
Definitionen von Fehlermeldungen und alle Fehlercodes finden Sie in der Google Cloud-Fehler
dokumentation.
Im Folgenden sind einige häufige Fehler aufgeführt, die bei der Fahrtüberwachung auftreten können:
| HTTP | RPC | Beschreibung |
|---|---|---|
| 400 | INVALID_ARGUMENT | Der Client hat einen ungültigen Namen für die Fahrt angegeben. Der Name der Fahrt 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 | UNAUTHENTICATED | Dieser Fehler tritt auf, wenn keine gültigen Anmeldedaten vorhanden sind. Beispiel: Das JWT-Token wurde ohne Fahrt-ID signiert oder das JWT-Token ist abgelaufen. |
| 403 | PERMISSION_DENIED | Dieser Fehler tritt auf, wenn der Client nicht über ausreichende Berechtigungen verfügt (z. B. wenn ein Nutzer mit der Rolle „Consumer“ versucht, „updateTrip“ aufzurufen), wenn das JWT-Token ungültig ist oder wenn die API für das Clientprojekt nicht aktiviert ist. Das JWT-Token fehlt möglicherweise oder das Token wurde mit einer Fahrt-ID signiert, die nicht mit der angeforderten Fahrt-ID übereinstimmt. |
| 429 | RESOURCE_EXHAUSTED | Das Ressourcenkontingent ist auf null gesetzt 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 der Aufrufer eine Frist festlegt, die kürzer als die Standardfrist der Methode ist (d. h. die angeforderte Frist reicht nicht aus, damit der Server die Anfrage verarbeiten kann) und die Anfrage nicht innerhalb der Frist abgeschlossen wurde. |
Fehler im Consumer SDK behandeln
Das Consumer SDK sendet Fehler bei der Fahrtaktualisierung ü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. Die 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 TripUpdateError zurückgegeben wird.onTripUpdateError()
// 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 TripUpdateError zurückgegeben wird.onTripUpdateError()
// 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 beziehen sich auf Netzwerk- oder Serverfehler. Sie müssen keine Maßnahmen ergreifen, um sie zu beheben. Das Consumer SDK stellt sie automatisch wieder her.
| Statuscode | Beschreibung |
|---|---|
| ABORTED | Der Server hat das Senden der Antwort beendet. Dies wird normalerweise durch ein Serverproblem verursacht. |
| CANCELLED | Der Server hat die ausgehende Antwort beendet. Das passiert normalerweise, wenn
die App in den Hintergrund verschoben wird oder wenn sich der Status in der Consumer-App ändert. |
| INTERRUPTED | |
| DEADLINE_EXCEEDED | Die Antwort des Servers hat zu lange gedauert. |
| UNAVAILABLE | Der Server war nicht verfügbar. Dies wird normalerweise durch ein Netzwerk Problem verursacht. |
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 gemeinsame Nutzung von Fahrten beenden. Es kann jedoch erst wiederhergestellt werden, wenn Sie Maßnahmen ergreifen.
| Statuscode | Beschreibung |
|---|---|
| INVALID_ARGUMENT | Die Consumer-App hat einen ungültigen Namen für die Fahrt angegeben. Der Name der Fahrt muss
dem Format providers/{provider_id}/trips/{trip_id} entsprechen.
|
| NOT_FOUND | Die Fahrt wurde nie erstellt. |
| PERMISSION_DENIED | Die Consumer-App hat nicht genügend Berechtigungen. Dieser Fehler tritt auf, wenn:
|
| RESOURCE_EXHAUSTED | Das Ressourcenkontingent ist auf null gesetzt oder die Trafficrate überschreitet das Limit. |
| UNAUTHENTICATED | Die Authentifizierung der Anfrage ist aufgrund eines ungültigen JWT-Tokens fehlgeschlagen. Dieser Fehler tritt auf, wenn das JWT-Token ohne Fahrt-ID signiert wurde oder wenn das JWT-Token abgelaufen ist. |