Das Driver SDK ist eine Bibliothek, die Sie in Ihre Treiber-App einbinden können. Damit wird die Fleet Engine mit Standort, Route, verbleibender Entfernung und voraussichtlicher Ankunftszeit aktualisiert. Er lässt sich auch in das Navigation SDK einbinden, das dem Fahrer eine detaillierte Routenführung bietet.
Mindestsystemanforderungen
Voraussetzungen
In dieser Anleitung wird davon ausgegangen, dass das Navigation SDK in Ihrer Anwendung bereits implementiert ist und das Fleet Engine-Back-End eingerichtet und verfügbar ist. Der Beispielcode enthält jedoch ein Beispiel für die Einrichtung des Navigation SDK.
Außerdem müssen Sie das Maps SDK for iOS in Ihrem Google Cloud-Projekt aktivieren und API-Schlüssel abrufen.
Zugriff erhalten
Wenn Sie Google Workspace-Kunde sind, erstellen Sie beim Onboarding eine Arbeitsbereichsgruppe wie google-maps-platform-sdk-users@workspacedomain.com und teilen Sie Google den Namen mit. Dies ist der empfohlene Ansatz.
Ihre Arbeitsbereichsgruppe wird dann einer Zulassungsliste hinzugefügt, die Zugriff auf die richtigen CocoaPods-Repositories gewährt. Prüfen Sie, ob die E-Mail-Adressen der Nutzer und Dienstkonten, die Zugriff benötigen, in dieser Liste enthalten sind.
Wenn Ihre Organisation keine Workspace-Gruppen erstellen kann, senden Sie eine Liste der Nutzer- und Dienstkonto-E-Mail-Adressen, die Zugriff auf diese Artefakte benötigen, an Google.
Lokale Entwicklung
Für die lokale Entwicklung reicht es aus, sich mit dem Cloud SDK anzumelden.
gcloud
gcloud auth login
Die für die Anmeldung verwendete E-Mail-Adresse muss Mitglied der Workspace-Gruppe sein.
Automatisierung (Systeme erstellen oder kontinuierliche Integration)
Richten Sie Automatisierungshosts gemäß den Best Practices ein:
Wenn Ihr Prozess in einer Google Cloud-Umgebung ausgeführt wird, verwenden Sie die automatische Erkennung von Anmeldedaten.
Speichern Sie andernfalls die Dienstkonto-Schlüsseldatei an einem sicheren Ort im Dateisystem des Hosts und legen Sie die Umgebungsvariable GOOGLE_APPLICATION_CREDENTIALS entsprechend fest.
Die mit den Anmeldedaten verknüpfte E-Mail-Adresse des Dienstkontos muss Mitglied der Arbeitsbereichsgruppe sein.
Projektkonfiguration
Sie können das Driver SDK mit CocoaPods konfigurieren.
Mit CocoaPods
Wenn Sie das Driver SDK mit CocoaPods konfigurieren möchten, benötigen Sie Folgendes:
- CocoaPods-Tool: Öffnen Sie zum Installieren dieses Tools das Terminal und führen Sie den folgenden Befehl aus.
shell sudo gem install cocoapodsWeitere Informationen finden Sie im Startleitfaden für CocoaPods.
Erstellen Sie eine Podfile-Datei für das Driver SDK und installieren Sie damit die API und ihre Abhängigkeiten: Erstellen Sie in Ihrem Projektverzeichnis eine Datei namens Podfile. In dieser Datei sind die Abhängigkeiten Ihres Projekts definiert. Bearbeiten Sie die Podfile-Datei und fügen Sie Ihre Abhängigkeiten hinzu. Hier ist ein Beispiel mit den Abhängigkeiten:
source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' endSpeichern Sie die Podfile-Datei. Öffnen Sie ein Terminal und wechseln Sie zum Verzeichnis mit der Podfile-Datei:
cd <path-to-project>Führen Sie den Befehl „pod install“ aus. Dadurch werden die im Podfile angegebenen APIs und ggf. vorhandene Abhängigkeiten installiert.
pod installSchließen Sie Xcode und öffnen Sie dann per Doppelklick die .xcworkspace-Datei Ihres Projekts, um Xcode zu starten. Ab jetzt müssen Sie das Projekt mit der .xcworkspace-Datei öffnen.
SDK-Versionen (Alpha/Beta)
Zum Konfigurieren der Alpha- oder Betaversionen des Driver SDK für iOS benötigen Sie Folgendes:
CocoaPods-Tool: Öffnen Sie zum Installieren dieses Tools das Terminal und führen Sie den folgenden Befehl aus.
sudo gem install cocoapodsWeitere Informationen finden Sie im Startleitfaden zu CocoaPods.
Ihr Entwicklerkonto in der Google-Zugriffsliste. Das Pod-Repository der Alpha- und Betaversionen des SDK ist keine öffentliche Quelle. Wenden Sie sich an den Google Customer Engineer, um auf diese Versionen zuzugreifen. Der Entwickler fügt Ihr Entwicklerkonto der Zugriffsliste hinzu und setzt ein Cookie für die Authentifizierung.
Sobald sich Ihr Projekt in der Zugriffsliste befindet, können Sie auf den Pod zugreifen.
Erstellen Sie eine Podfile-Datei für das Treiber-SDK für iOS und installieren Sie damit die API und ihre Abhängigkeiten: Erstellen Sie in Ihrem Projektverzeichnis eine Datei mit dem Namen Podfile. In dieser Datei sind die Abhängigkeiten Ihres Projekts definiert. Bearbeiten Sie die Podfile-Datei und fügen Sie Ihre Abhängigkeiten hinzu. Hier ist ein Beispiel mit den Abhängigkeiten:
source "https://cpdc-eap.googlesource.com/ridesharing-driver-sdk.git" source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' endSpeichern Sie die Podfile-Datei. Öffnen Sie ein Terminal und wechseln Sie zum Verzeichnis mit der Podfile-Datei:
cd <path-to-project>Führen Sie den Befehl „pod install“ aus. Dadurch werden die im Podfile angegebenen APIs und ggf. vorhandene Abhängigkeiten installiert.
pod installSchließen Sie Xcode und öffnen Sie dann per Doppelklick die .xcworkspace-Datei Ihres Projekts, um Xcode zu starten. Ab jetzt müssen Sie das Projekt mit der .xcworkspace-Datei öffnen.
XCFramework installieren
Ein XCFramework ist ein Binärpaket, mit dem Sie das Treiber-SDK installieren. Sie können dieses Paket auf mehreren Plattformen verwenden, einschließlich Computern mit dem M1-Chipsatz. In diesem Leitfaden erfahren Sie, wie Sie das XCFramework, das das Treiber-SDK enthält, Ihrem Projekt manuell hinzufügen und Ihre Build-Einstellungen in Xcode konfigurieren.
Laden Sie das SDK-Binärprogramm und die Ressourcen herunter:
Entpacken Sie die ZIP-Dateien, um auf XCFramework und Ressourcen zuzugreifen.
Starten Sie Xcode und öffnen Sie entweder ein vorhandenes Projekt oder erstellen Sie ein neues Projekt. Wenn Sie neu bei iOS sind, erstellen Sie ein neues Projekt und wählen Sie die Vorlage für die iOS-App aus.
Erstellen Sie eine Frameworks-Gruppe unter Ihrer Projektgruppe, falls noch keine vorhanden ist.
Ziehen Sie die heruntergeladene Datei
gRPCCertificates.bundlein das Verzeichnis der obersten Ebene Ihres Xcode-Projekts. Wählen Sie bei Aufforderung Elemente kopieren (falls erforderlich) aus.Ziehen Sie die Datei
GoogleRidesharingDriver.xcframeworkin Ihr Projekt unter Frameworks, Libraries, and Embedded Content (Frameworks, Bibliotheken und eingebettete Inhalte), um das Treiber-SDK zu installieren. Wählen Sie bei Aufforderung Elemente kopieren (falls erforderlich) aus.Ziehen Sie die heruntergeladene Datei
GoogleRidesharingDriver.bundlein das Verzeichnis der obersten Ebene Ihres Xcode-Projekts. Wenn Sie dazu aufgefordert werden, wählen SieCopy items if neededaus.Wählen Sie Ihr Projekt aus dem Project Navigator und anschließend das Ziel Ihrer App aus.
Öffnen Sie den Tab „Build Phases“ (Build-Phasen) und fügen Sie in „Link Binary with Libraries“ (Binärdatei mit Bibliotheken verknüpfen) die folgenden Frameworks und Bibliotheken hinzu, sofern sie noch nicht vorhanden sind:
Accelerate.frameworkAudioToolbox.frameworkAVFoundation.frameworkCoreData.frameworkCoreGraphics.frameworkCoreLocation.frameworkCoreTelephony.frameworkCoreText.frameworkGLKit.frameworkImageIO.frameworklibc++.tbdlibxml2.tbdlibz.tbdLocalAuthentication.frameworkOpenGLES.frameworkQuartzCore.frameworkSystemConfiguration.frameworkUIKit.frameworkWebKit.framework
Wählen Sie Ihr Projekt anstelle eines bestimmten Ziels aus und öffnen Sie den Tab Build Settings (Build-Einstellungen). Fügen Sie im Bereich Other Linker Flags sowohl für das Debugging als auch für den Release
‑ObjChinzu. Wenn diese Einstellungen nicht sichtbar sind, ändern Sie den Filter in der Leiste mit den Build-Einstellungen von Einfach zu Alle.
Autorisierung und Authentifizierung implementieren
Wenn Ihre Treiber-App Aktualisierungen generiert und an das Fleet Engine-Back-End sendet, müssen die Anfragen gültige Zugriffstokens enthalten. Zum Autorisieren und Authentifizieren dieser Anfragen ruft das Driver SDK Ihr Objekt in Übereinstimmung mit dem GMTDAuthorization-Protokoll auf. Das -Objekt ist für die Bereitstellung des erforderlichen Zugriffstokens verantwortlich.
Als App-Entwickler entscheiden Sie, wie Tokens generiert werden. Ihre Implementierung sollte Folgendes ermöglichen:
- Rufen Sie ein Zugriffstoken im JSON-Format von einem HTTPS-Server ab.
- Parsen Sie das Token und speichern Sie es im Cache.
- Aktualisieren Sie das Token, wenn es abläuft.
Weitere Informationen zu den vom Fleet Engine-Server erwarteten Tokens finden Sie unter JSON Web Token (JWT) zur Autorisierung erstellen.
Die Anbieter-ID ist mit der Google Cloud-Projekt-ID identisch. Weitere Informationen finden Sie im Nutzerhandbuch der Fleet Engine Deliveries API.
Im folgenden Beispiel wird ein Zugriffstokenanbieter implementiert:
#import "SampleAccessTokenProvider.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
// SampleAccessTokenProvider.h
@interface SampleAccessTokenProvider : NSObject<GMTDAuthorization>
@end
static NSString *const PROVIDER_URL = @"INSERT_YOUR_TOKEN_PROVIDER_URL";
// SampleAccessTokenProvider.m
@implementation SampleAccessTokenProvider{
// The cached vehicle token.
NSString *_cachedVehicleToken;
// Keep track of the vehicle ID the cached token is for.
NSString *_lastKnownVehicleID;
// Keep track of when tokens expire for caching.
NSTimeInterval _tokenExpiration;
}
- (void)fetchTokenWithContext:(nullable GMTDAuthorizationContext *)authorizationContext
completion:(nonnull GMTDAuthTokenFetchCompletionHandler)completion {
if (!completion) {
NSAssert(NO, @"%s encountered an unexpected nil completion.", __PRETTY_FUNCTION__);
return;
}
// Get the vehicle ID from the authorizationContext. This is set by the Driver SDK.
NSString *vehicleID = authorizationContext.vehicleID;
if (!vehicleID) {
NSAssert(NO, @"Vehicle ID is missing from authorizationContext.");
return;
}
// Clear cached vehicle token if vehicle ID has changed.
if (![_lastKnownVehicleID isEqual:vehicleID]) {
_tokenExpiration = 0.0;
_cachedVehicleToken = nil;
}
_lastKnownVehicleID = vehicleID;
// Clear cached vehicle token if it has expired.
if ([[NSDate date] timeIntervalSince1970] > _tokenExpiration) {
_cachedVehicleToken = nil;
}
// If appropriate, use the cached token.
if (_cachedVehicleToken) {
completion(_cachedVehicleToken, nil);
return;
}
// Otherwise, try to fetch a new token from your server.
NSURL *requestURL = [NSURL URLWithString:PROVIDER_URL];
NSMutableURLRequest *request =
[[NSMutableURLRequest alloc] initWithURL:requestURL];
request.HTTPMethod = @"GET";
// Replace the following key values with the appropriate keys based on your
// server's expected response.
NSString *vehicleTokenKey = @"VEHICLE_TOKEN_KEY";
NSString *tokenExpirationKey = @"TOKEN_EXPIRATION";
__weak typeof(self) weakSelf = self;
void (^handler)(NSData *_Nullable data, NSURLResponse *_Nullable response,
NSError *_Nullable error) =
^(NSData *_Nullable data, NSURLResponse *_Nullable response, NSError *_Nullable error) {
typeof(self) strongSelf = weakSelf;
if (error) {
completion(nil, error);
return;
}
NSError *JSONError;
NSMutableDictionary *JSONResponse =
[NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:&JSONError];
if (JSONError) {
completion(nil, JSONError);
return;
} else {
// Sample code only. No validation logic.
id expirationData = JSONResponse[tokenExpirationKey];
if ([expirationData isKindOfClass:[NSNumber class]]) {
NSTimeInterval expirationTime = ((NSNumber *)expirationData).doubleValue;
strongSelf->_tokenExpiration = [[NSDate date] timeIntervalSince1970] + expirationTime;
}
strongSelf->_cachedVehicleToken = JSONResponse[vehicleTokenKey];
completion(JSONResponse[vehicleTokenKey], nil);
}
};
NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
NSURLSession *mainQueueURLSession =
[NSURLSession sessionWithConfiguration:config delegate:nil
delegateQueue:[NSOperationQueue mainQueue]];
NSURLSessionDataTask *task = [mainQueueURLSession dataTaskWithRequest:request completionHandler:handler];
[task resume];
}
@end
DeliveryDriverAPI-Instanz erstellen
Zum Abrufen einer GMTDDeliveryVehicleReporter-Instanz müssen Sie zuerst eine GMTDDeliveryDriverAPI-Instanz mit der ProviderID, der Fahrzeug-ID, dem DriverContext und dem accessTokenProvider erstellen. Die Anbieter-ID ist mit der Google Cloud-Projekt-ID identisch. Außerdem können Sie direkt über die Treiber-API auf die GMTDDeliveryVehicleReporter-Instanz zugreifen.
Im folgenden Beispiel wird eine GMTDDeliveryDriverAPI-Instanz erstellt:
#import “SampleViewController.h”
#import “SampleAccessTokenProvider.h”
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
NSString *vehicleID = @"INSERT_CREATED_VEHICLE_ID";
SampleAccessTokenProvider *accessTokenProvider =
[[SampleAccessTokenProvider alloc] init];
GMTDDriverContext *driverContext =
[[GMTDDriverContext alloc] initWithAccessTokenProvider:accessTokenProvider
providerID:PROVIDER_ID
vehicleID:vehicleID
navigator:_mapView.navigator];
GMTDDeliveryDriverAPI *deliveryDriverAPI = [[GMTDDeliveryDriverAPI alloc] initWithDriverContext:driverContext];
}
Optional auf VehicleReporter-Ereignisse warten
GMTDDeliveryVehicleReporter aktualisiert das Fahrzeug regelmäßig, wenn locationTrackingEnabled auf YES (JA) gesetzt ist. Um auf diese regelmäßigen Aktualisierungen zu reagieren, kann jedes Objekt GMTDDeliveryVehicleReporter-Ereignisse abonnieren, wenn es dem GMTDVehicleReporterListener-Protokoll entspricht.
Sie können die folgenden Ereignisse verarbeiten:
vehicleReporter:didSucceedVehicleUpdateInformiert die Fahrer-App darüber, dass die Back-End-Dienste den Standort und Status des Fahrzeugs erfolgreich empfangen haben.
vehicleReporter:didFailVehicleUpdate:withErrorInformiert den Listener, dass ein Fahrzeugupdate fehlgeschlagen ist. Solange das Standort-Tracking aktiviert ist, sendet
GMTDDeliveryVehicleReporterweiterhin die neuesten Daten an das Fleet Engine-Back-End.
Im folgenden Beispiel werden diese Ereignisse verarbeitet:
SampleViewController.h
@interface SampleViewController : UIViewController<GMTDVehicleReporterListener>
@end
SampleViewController.m
#import “SampleViewController.h”
#import “SampleAccessTokenProvider.h”
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
// ASSUMES YOU IMPLEMENTED HAVE THE SAMPLE CODE UP TO THIS STEP.
[ridesharingDriverAPI.vehicleReporter addListener:self];
}
- (void)vehicleReporter:(GMTDDeliveryVehicleReporter *)vehicleReporter didSucceedVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate {
// Handle update succeeded.
}
- (void)vehicleReporter:(GMTDDeliveryVehicleReporter *)vehicleReporter didFailVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate withError:(NSError *)error {
// Handle update failed.
}
@end
Standortermittlung aktivieren
Um das Standort-Tracking zu aktivieren, kann deine App locationTrackingEnabled auf GMTDDeliveryVehicleReporter auf YES setzen. Dann sendet GMTDDeliveryVehicleReporter automatisch Standortaktualisierungen. Wenn GMSNavigator im Navigationsmodus ist (wenn ein Ziel über setDestinations festgelegt wurde) und locationTrackingEnabled auf YES gesetzt ist, sendet GMTDDeliveryVehicleReporter automatisch auch Aktualisierungen der Route und der voraussichtlichen Ankunftszeit.
Die dabei festgelegte Route ist dieselbe, die der Fahrer während der Navigation verwendet. Damit die Sendungsverfolgung ordnungsgemäß funktioniert, sollte der über -setDestinations:callback: festgelegte Wegpunkt mit dem im Fleet Engine-Back-End festgelegten Ziel übereinstimmen.
Im folgenden Beispiel wird die Standortermittlung aktiviert:
SampleViewController.m
#import “SampleViewController.h”
#import “SampleAccessTokenProvider.h”
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
static NSString *const PROVIDER_ID = @"INSERT_YOUR_PROVIDER_ID";
@implementation SampleViewController {
GMSMapView *_mapView;
}
- (void)viewDidLoad {
// ASSUMES YOU IMPLEMENTED HAVE THE SAMPLE CODE UP TO THIS STEP.
deliveryDriverAPI.vehicleReporter.locationTrackingEnabled = YES;
}
@end
Standardmäßig beträgt das Berichtsintervall 10 Sekunden, das Berichtsintervall kann jedoch mit locationUpdateInterval geändert werden. Das unterstützte Mindestaktualisierungsintervall beträgt 5 Sekunden. Das maximal unterstützte Aktualisierungsintervall beträgt 60 Sekunden. Häufigere Aktualisierungen können zu langsameren Anfragen und Fehlern führen.
Standortaktualisierungen deaktivieren
Deine App kann Standortupdates für ein Fahrzeug deaktivieren. Wenn beispielsweise die Schicht eines Fahrers endet, kann Ihre App locationTrackingEnabled auf NO setzen.
_vehicleReporter.locationTrackingEnabled = NO
Fehler vom Typ „update_mask“ behandeln
Wenn GMTDDeliveryVehicleReporter ein Fahrzeugupdate sendet, kann ein update_mask-Fehler auftreten, wenn die Maske leer ist. Dieser Fehler tritt normalerweise bei der ersten Aktualisierung nach dem Start auf. Das folgende Beispiel zeigt, wie dieser Fehler behandelt wird:
Swift
import GoogleRidesharingDriver
class VehicleReporterListener: NSObject, GMTDVehicleReporterListener {
func vehicleReporter(
_ vehicleReporter: GMTDVehicleReporter,
didFail vehicleUpdate: GMTDVehicleUpdate,
withError error: Error
) {
let fullError = error as NSError
if let innerError = fullError.userInfo[NSUnderlyingErrorKey] as? NSError {
let innerFullError = innerError as NSError
if innerFullError.localizedDescription.contains("update_mask cannot be empty") {
emptyMaskUpdates += 1
return
}
}
failedUpdates += 1
}
override init() {
emptyMaskUpdates = 0
failedUpdates = 0
}
}
Objective-C
#import "VehicleReporterListener.h"
#import <GoogleRidesharingDriver/GoogleRidesharingDriver.h>
@implementation VehicleReporterListener {
NSInteger emptyMaskUpdates = 0;
NSInteger failedUpdates = 0;
}
- (void)vehicleReporter:(GMTDVehicleReporter *)vehicleReporter
didFailVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate
withError:(NSError *)error {
for (NSError *underlyingError in error.underlyingErrors) {
if ([underlyingError.localizedDescription containsString:@"update_mask cannot be empty"]) {
emptyMaskUpdates += 1;
return;
}
}
failedUpdates += 1
}
@end