Erste Schritte mit dem Driver SDK für iOS

Das Driver SDK ist eine Bibliothek, die Sie in Ihre Treiber-App integrieren können. Es ist die Fleet Engine mit Standort, Route, verbleibende Strecke und voraussichtliche Ankunftszeit. Es lässt sich auch in das Navigation SDK integrieren, das eine detaillierte Routenführung für den Fahrer.

Mindestsystemanforderungen

  • Auf dem Mobilgerät muss iOS 14 oder höher installiert sein.
  • Xcode Version 15 oder höher.

    • Vorbereitung

    In diesem Leitfaden wird davon ausgegangen, dass die Navigation SDK verwenden und dass das Flottenmotor Back-End eingerichtet und verfügbar ist. Der Beispielcode bietet jedoch ein Beispiel für die Einrichtung des Navigation SDK

    Außerdem müssen Sie das Maps SDK for iOS aktivieren. in Ihrem Google Cloud-Projekt und rufen Sie einen API-Schlüssel ab.

    Zugriff erhalten

    Wenn Sie Google Workspace-Kunde sind, erstellen Sie Arbeitsbereichsgruppe wie google-maps-platform-sdk-users@workspacedomain.com während des Onboardings und den Namen an Google weiterzugeben. Dies ist der empfohlene Ansatz. Ihre Workspace-Gruppe wird dann einer Zulassungsliste hinzugefügt, die gewährt Zugriff auf die richtigen CocoaPods-Repositories. Prüfen, ob der Nutzer E-Mail-Adressen und Dienstkonto-E-Mail-Adressen, die Zugriff benötigen, sind in dieser Liste enthalten.

    Wenn Ihre Organisation keine Workspace-Gruppen erstellen kann, senden Sie eine Liste an Google von Nutzer- und Dienstkonto-E-Mails, die Zugriff auf diese Artefakte benötigen.

    Lokale Entwicklung

    Für die lokale Entwicklung reicht es aus, sich mit dem Cloud SDK:

    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äß Best Practices:

    • Wenn Ihr Prozess in einer Google Cloud-Umgebung ausgeführt wird, verwenden Sie automatisch Erkennung von Anmeldedaten.

    • Andernfalls speichern Sie die Dienstkonto-Schlüsseldatei an einem sicheren Ort auf der Host-Dateisystem und legen Sie GOOGLE_APPLICATION_CREDENTIALS Umgebungsvariable entsprechend an.

    Die mit den Anmeldedaten verknüpfte E-Mail-Adresse des Dienstkontos muss Mitglied von Workspace-Gruppierung.

    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 des Tools das Terminal und führen Sie den folgenden Befehl. shell sudo gem install cocoapods Weitere Informationen finden Sie im Startleitfaden für CocoaPods .

    1. Erstellen Sie eine Podfile-Datei für das Treiber-SDK und installieren Sie damit das API und ihre Abhängigkeiten: Erstellen Sie im Projekt eine Datei mit dem Namen Podfile -Verzeichnis. In dieser Datei sind die Abhängigkeiten Ihres Projekts definiert. Podfile bearbeiten und fügen Sie Ihre Abhängigkeiten hinzu. Hier ist ein Beispiel mit dem Abhängigkeiten:

      source "https://github.com/CocoaPods/Specs.git"

target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
  pod 'GoogleRidesharingDriver'
end

    2. Speichern Sie die Podfile-Datei. Öffnen Sie ein Terminal und wechseln Sie zum Verzeichnis mit den Podfile:

      cd <path-to-project>

    3. Führen Sie den Befehl „pod install“ aus. Dadurch werden die APIs installiert, die im Podfile und mögliche Abhängigkeiten.

      pod install

    4. Schließen Sie Xcode und öffnen Sie dann per Doppelklick die .xcworkspace-Datei Ihres Projekts. um Xcode zu starten. Ab diesem Zeitpunkt müssen Sie die .xcworkspace-Datei verwenden um das Projekt zu öffnen.

    SDK-Versionen (Alpha/Beta)

    Zum Konfigurieren der Alpha- oder Betaversionen des Treiber-SDK für iOS benötigen Sie die folgenden Elemente:

    • CocoaPods-Tool: Öffnen Sie zum Installieren des Tools das Terminal und führen Sie den folgenden Befehl.

      sudo gem install cocoapods

      Weitere Informationen finden Sie im Startleitfaden für CocoaPods .

    • Ihr Entwicklerkonto in der Google-Zugriffsliste. Das Pod-Repository der Alpha- und Betaversionen des SDK sind keine öffentliche Quelle. Bis auf diese Versionen zugreifen, wenden Sie sich an den Google Customer Engineer. Der Entwickler fügt Ihr Entwicklungskonto der Zugriffsliste hinzu und setzt ein Cookie für Authentifizierung.

    Sobald sich Ihr Projekt in der Zugriffsliste befindet, können Sie auf den Pod zugreifen.

    1. Erstellen Sie eine Podfile-Datei für das Treiber-SDK für iOS und installieren Sie damit das API und ihre Abhängigkeiten: Erstellen Sie im Projekt eine Datei mit dem Namen Podfile -Verzeichnis. In dieser Datei sind die Abhängigkeiten Ihres Projekts definiert. Podfile bearbeiten und fügen Sie Ihre Abhängigkeiten hinzu. Hier ist ein Beispiel mit dem 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'
end

    2. Speichern Sie die Podfile-Datei. Öffnen Sie ein Terminal und wechseln Sie zum Verzeichnis mit den Podfile:

      cd <path-to-project>

    3. Führen Sie den Befehl „pod install“ aus. Dadurch werden die APIs installiert, die im Podfile und mögliche Abhängigkeiten.

      pod install

    4. Schließen Sie Xcode und öffnen Sie dann per Doppelklick die .xcworkspace-Datei Ihres Projekts. um Xcode zu starten. Ab diesem Zeitpunkt müssen Sie die .xcworkspace-Datei verwenden um das Projekt zu ö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:

    1. Entpacken Sie die ZIP-Dateien, um auf XCFramework und Ressourcen zuzugreifen.

    2. 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.

    3. Erstellen Sie eine Frameworks-Gruppe unter Ihrer Projektgruppe, falls noch keine vorhanden ist.

    4. Ziehen Sie die heruntergeladene Datei gRPCCertificates.bundle in das Verzeichnis der obersten Ebene Ihres Xcode-Projekts. Wählen Sie bei Aufforderung Elemente kopieren (falls erforderlich) aus.

    5. Ziehen Sie die Datei GoogleRidesharingDriver.xcframework in 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.

    6. Ziehen Sie die heruntergeladene Datei GoogleRidesharingDriver.bundle in das Verzeichnis der obersten Ebene Ihres Xcode-Projekts. Wenn Sie dazu aufgefordert werden, wählen Sie Copy items if needed aus.

    7. Wählen Sie Ihr Projekt aus dem Project Navigator und anschließend das Ziel Ihrer App aus.

    8. Ö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.framework
      • AudioToolbox.framework
      • AVFoundation.framework
      • CoreData.framework
      • CoreGraphics.framework
      • CoreLocation.framework
      • CoreTelephony.framework
      • CoreText.framework
      • GLKit.framework
      • ImageIO.framework
      • libc++.tbd
      • libxml2.tbd
      • libz.tbd
      • LocalAuthentication.framework
      • OpenGLES.framework
      • QuartzCore.framework
      • SystemConfiguration.framework
      • UIKit.framework
      • WebKit.framework

    9. 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 ‑ObjC hinzu. Wenn diese Einstellungen nicht sichtbar sind, ändern Sie den Filter in der Leiste mit den Build-Einstellungen von Einfach zu Alle.

    Apple Privacy Manifest-Datei prüfen

    Apple verlangt, dass für Apps im App Store Details zum App-Datenschutz angegeben werden. Aktuelle Informationen und weitere Informationen finden Sie auf der Seite zu Datenschutzdetails im Apple App Store.

    Die Apple Privacy Manifest-Datei ist im Ressourcenpaket für das SDK enthalten. Wenn Sie prüfen möchten, ob die Privacy Manifest-Datei enthalten ist, und ihren Inhalt prüfen möchten, erstellen Sie ein Archiv Ihrer App und generieren Sie aus dem Archiv einen Datenschutzbericht.

    Autorisierung und Authentifizierung implementieren

    Wenn Ihre Treiber-App Updates generiert und an das Fleet Engine-Back-End sendet, Die Anfragen müssen gültige Zugriffstokens enthalten. Zum Autorisieren und diese Anfragen authentifizieren müssen, ruft das Driver SDK Ihr Objekt auf GMTDAuthorization Protokoll. 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. Siehe 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 mithilfe der Anbieter-ID, „vehicleID“, „driveContext“ und „accessTokenProvider“. Die Anbieter-ID ist identisch mit Google Cloud-Projekt-ID. Sie haben Zugriff auf die GMTDDeliveryVehicleReporter direkt aus der Treiber-API aus.

    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 ist JA. Um auf diese regelmäßigen Updates zu reagieren, GMTDDeliveryVehicleReporter-Ereignisse abonnieren können, indem das GMTDVehicleReporterListener-Protokoll.

    Sie können die folgenden Ereignisse verarbeiten:

    • vehicleReporter:didSucceedVehicleUpdate

      Informiert die Treiber-App, dass die Backend-Dienste den Aktualisierung von Fahrzeugstandort und Fahrzeugstatus.

    • vehicleReporter:didFailVehicleUpdate:withError

      Informiert den Listener, dass ein Fahrzeugupdate fehlgeschlagen ist. Solange der Standort aktiviert ist, sendet GMTDDeliveryVehicleReporter weiterhin Daten an das Fleet Engine-Back-End senden.

    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 die Standortermittlung zu aktivieren, kann deine App locationTrackingEnabled auf YES setzen am GMTDDeliveryVehicleReporter. Dann wird GMTDDeliveryVehicleReporter = automatisch Standortupdates senden. Wenn sich „GMSNavigator“ in der Navigation befindet Modus (wenn ein Ziel über setDestinations festgelegt wurde) und locationTrackingEnabled ist auf YES gesetzt, GMTDDeliveryVehicleReporter macht automatisch auch Updates zu Routen und Ankunftszeiten.

    Für diese Updates wird dieselbe Route wie für den Fahrer festgelegt. die während der Navigation angezeigt wird. Damit die Sendungsverfolgung funktioniert, muss der über -setDestinations:callback: festgelegte Wegpunkt mit der im Fleet Engine-Back-End festgelegt ist.

    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 5 Sekunden beträgt. 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 zum Beispiel ein die Schicht des Fahrgasts endet, kann deine App locationTrackingEnabled auf NO setzen.

      _vehicleReporter.locationTrackingEnabled = NO

    Fehler vom Typ „update_mask“ behandeln

    Wenn GMTDDeliveryVehicleReporter ein Fahrzeugupdate sendet, wird eine update_mask kann auftreten, wenn die Maske leer ist. Er tritt normalerweise beim ersten nach dem Start aktualisiert werden. 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