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 Fahrzeugstandort, Route, verbleibende Strecke und voraussichtliche Ankunftszeit. Sie 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 .
  • Xcode Version 15 oder höher.
  • Vorbereitung

    In diesem Leitfaden wird davon ausgegangen, dass die Navigation in Ihrer App bereits SDK und die Flotte Motor Back-End eingerichtet und verfügbar ist. Der Beispielcode enthält jedoch Navigation SDK einrichten.

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

    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 Hosts und legen Sie den GOOGLE_APPLICATION_CREDENTIALS Umgebungsvariable entsprechend an.

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

    Projektkonfiguration

    Swift-Paketmanager

    Das Treiber-SDK kann über installiert werden. Swift Package Manager Damit du das SDK hinzufügen kannst, alle vorhandenen Driver SDK-Abhängigkeiten entfernt wurden.

    So fügen Sie das SDK einem neuen oder vorhandenen Projekt hinzu:

    1. Öffne deinen Xcode project oder workspace und klicke auf Datei > Paketabhängigkeiten hinzufügen.
    2. Geben Sie https://github.com/googlemaps/ios-driver-sdk als URL ein und drücken Sie die Eingabetaste. um das Paket zu laden, und klicke auf „Paket hinzufügen“.
    3. Wenn Sie eine bestimmte version installieren möchten, legen Sie das Feld Abhängigkeitsregel auf eine der folgenden Optionen fest: zu den versionsbasierten Optionen. Für neue Projekte empfehlen wir, die neueste Version und mit der Spalte „Exakte Version“ Option. Klicke anschließend auf „Paket hinzufügen“.
    4. Prüfe im Fenster Paketprodukte auswählen, ob GoogleRidesharingDriver hinzugefügt wird Ihr festgelegtes Ziel für main. Klicke anschließend auf „Paket hinzufügen“.
    5. Um die Installation zu überprüfen, navigiere zum Bereich General deines Ziels. Die installierten Pakete sollten nun unter Frameworks, Bibliotheken und eingebettete Inhalte zu sehen sein. Sie können auch die „Paketabhängigkeiten“ von Projektnavigator um das Paket und seine Version zu überprüfen.

    So aktualisieren Sie den package für ein vorhandenes Projekt:

    1. Wenn Sie ein Upgrade von einer früheren Version als 9.0.0 durchführen,müssen Sie die folgenden Abhängigkeiten: GoogleMapsBase, GoogleMapsCore und GoogleMapsM4B nach dem Upgrade. Entfernen Sie nicht die Abhängigkeit für GoogleMaps Weitere Informationen finden Sie in der Versionshinweise zu Version 9.0.0

      Gehen Sie in den Konfigurationseinstellungen des Xcode-Projekts zu Frameworks, Libraries, und eingebettete Inhalte. Verwenden Sie das Minuszeichen(-), um das folgende Framework zu entfernen:

      • GoogleMapsBase (nur für Upgrades von Versionen vor 9.0.0)
      • GoogleMapsCore (nur für Upgrades von Versionen vor 9.0.0)
      • GoogleMapsM4B (nur für Upgrades von Versionen vor 9.0.0)
    2. Gehen Sie in Xcode zu „File > Pakete > Auf neueste Paketversionen aktualisieren“.
    3. Um die Installation zu überprüfen, gehen Sie in der Projektnavigation zum Abschnitt Paketabhängigkeiten. um das Paket und seine Version zu überprüfen.

    So entfernen Sie vorhandene Driver SDK-Abhängigkeiten, die mithilfe von CocoaPods, gehen Sie so vor:

    1. Schließen Sie den Xcode-Arbeitsbereich. Öffnen Sie das Terminal und führen Sie den folgenden Befehl aus:
      sudo gem install cocoapods-deintegrate cocoapods-clean 
      pod deintegrate 
      pod cache clean --all
    2. Entfernen Sie Podfile, Podfile.resolved und den Xcode workspace, wenn du sie ausschließlich für CocoaPods verwendest.

    So entfernen Sie das vorhandene Treiber SDK: können Sie diese Schritte manuell ausführen:

    1. Suchen Sie in den Xcode-Projektkonfigurationseinstellungen nach Frameworks, Bibliotheken und eingebettete Inhalte. Mit dem Minuszeichen(-) entfernen Sie folgendes Framework:

      • GoogleRidesharingDriver.xcframework
    2. Entfernen Sie im Verzeichnis der obersten Ebene Ihres Xcode-Projekts den GoogleRidesharingDriver Bundle.

    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.
       sudo gem install cocoapods
    
    1. Erstellen Sie eine Podfile-Datei für das Driver SDK und installieren Sie damit die API und 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 Abhängigkeiten. Hier ein Beispiel mit den Abhängigkeiten:

      source "https://github.com/CocoaPods/Specs.git"
      
      target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
        pod 'GoogleRidesharingDriver'
      end
      

      Hier ist ein Beispiel, das die Alpha- und Beta-Pods für die Treiber-SDK als 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 das .xcworkspace zum Öffnen des Projekts.

    Weitere Informationen finden Sie im Artikel Erste Schritte mit CocoaPods für weitere Informationen Details.

    Manuelle Installation

    Ein XCFramework ist ein Binärpaket, mit dem Sie das Treiber-SDK. Sie können dieses Paket auf mehreren einschließlich Computern, die Apple Silicon aus. In diesem Leitfaden erfahren Sie, wie Sie das XCFramework, das die Treiber SDK zu Ihrem Projekt hinzufügen und Ihren Build konfigurieren in Xcode ändern.

    Laden Sie das SDK-Binärprogramm und die Ressourcen herunter:

    1. Extrahieren Sie die Dateien, um auf XCFramework und Ressourcen zuzugreifen.

    2. Starten Sie Xcode und öffnen Sie entweder ein vorhandenes Projekt oder erstellen Sie ein neues Projekt arbeiten. Wenn Sie neu bei iOS sind, erstellen Sie ein neues Projekt und wählen Sie App-Vorlage.

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

    4. Um das Driver SDK zu installieren, ziehen Sie den GoogleRidesharingDriver.xcframework-Datei in Ihr Projekt unter Frameworks, Bibliotheken und eingebettete Inhalte. Wenn Sie dazu aufgefordert werden, wählen Sie Kopieren Sie bei Bedarf Elemente.

    5. Ziehe das heruntergeladene Element (GoogleRidesharingDriver.bundle) in die oberste Ebene Ihres Xcode-Projekts. Wenn Sie dazu aufgefordert werden, wählen Sie Copy items if needed aus.

    6. Wählen Sie im Project Navigator Ihr Projekt und dann Anwendungsziel.

    7. Öffnen Sie den Tab Build Phases (Build-Phasen) und fügen Sie in Link Binary with Libraries (Binärdatei mit Bibliotheken verknüpfen) den Parameter folgenden Frameworks und Bibliotheken, falls diese 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
    8. Wählen Sie Ihr Projekt anstelle eines bestimmten Ziels aus und öffnen Sie die Schaltfläche Build Einstellungen. Fügen Sie im Abschnitt Other Linker Flags (Weitere Verknüpfungs-Flags) -ObjC für Debug und Release. Wenn diese Einstellungen nicht sichtbar sind, ändern Sie filtern Sie in der Leiste mit den Build-Einstellungen von Einfach nach Alle.

    Apple Privacy Manifest-Datei prüfen

    Apple verlangt, dass bei 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 Ihre Objekt gemäß 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 mit providerID, vehicleID, driverContext und accessTokenProvider. providerID 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 überwachen

    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 das Ereignis 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 das Standort-Tracking zu aktivieren, kann deine App locationTrackingEnabled auf YES setzen am GMTDDeliveryVehicleReporter. Dann: GMTDDeliveryVehicleReporter sendet automatisch Standortaktualisierungen. Wenn sich „GMSNavigator“ in der Navigation befindet Modus (wenn ein Ziel über setDestinations festgelegt wurde) und locationTrackingEnabled ist auf YES, GMTDDeliveryVehicleReporter eingestellt automatisch auch Aktualisierungen der Route und voraussichtlicher Ankunftszeit.

    Die während dieser Aktualisierungen festgelegte Route entspricht der des Fahrers. die während der Navigation navigiert werden können. Damit die Flottenverfolgung 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 und Fahrzeug offline stellen

    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