Premiers pas avec le SDK Driver pour iOS

Le SDK Driver est une bibliothèque que vous intégrez dans votre application de pilote. Il est est responsable de la mise à jour de Fleet Engine avec l'emplacement, l'itinéraire la distance restante et l'heure d'arrivée prévue. Il s'intègre aussi au SDK Navigation, fournit des instructions de navigation détaillées au conducteur.

Configuration système minimale requise

Prérequis

Ce guide part du principe que votre application implémente déjà la SDK Navigation, et que la Moteur de flotte est configuré et disponible. Toutefois, l'exemple de code fournit un exemple de configuration SDK Navigation :

Vous devez également activer le SDK Maps pour iOS. dans votre projet Google Cloud et obtenir une clé API.

Obtenir l'accès

Si vous êtes un client Google Workspace, créez un Workspace Group, par exemple google-maps-platform-sdk-users@workspacedomain.com lors de l'intégration et fournir le nom à Google. Il s'agit de l'approche recommandée. Votre groupe Workspace est alors ajouté à une liste d'autorisation accorde l'accès aux dépôts CocoaPods appropriés. Vérifiez que l'utilisateur les adresses e-mail et les adresses e-mail de compte de service qui ont besoin d'y accéder.

Si votre organisation ne peut pas créer de groupes Workspace, envoyez une liste à Google des adresses e-mail d'utilisateurs et de comptes de service qui ont besoin d'accéder à ces artefacts.

Développement local

Pour le développement en local, il suffit de se connecter avec le SDK Cloud :

gcloud auth login

L'adresse e-mail utilisée pour se connecter doit être membre du groupe Workspace.

Automatisation (systèmes de compilation ou intégration continue)

Configurez vos hôtes d'automatisation en fonction bonnes pratiques:

• Si votre processus s'exécute dans un environnement Google Cloud, utilisez automatique la détection d'identifiants.

• Sinon, stockez le fichier de clé du compte de service dans un emplacement sécurisé système de fichiers de l'hôte et définir GOOGLE_APPLICATION_CREDENTIALS variable d'environnement de façon appropriée.

L'adresse e-mail du compte de service associée aux identifiants doit être membre de le groupe Workspace.

Configuration du projet

Vous pouvez configurer le SDK Driver pour iOS à l'aide de CocoaPods ou manuellement.

Inspecter le fichier manifeste de confidentialité Apple

Apple exige des informations sur la confidentialité des applications disponibles sur l'App Store. Pour obtenir des mises à jour et d'autres informations, consultez la page Informations sur la confidentialité sur l'App Store d'Apple.

Le fichier manifeste de confidentialité Apple est inclus dans le bundle de ressources pour le SDK. Pour vérifier que le fichier manifeste de confidentialité a été inclus et pour inspecter son contenu, créez une archive de votre application et générez un rapport sur la confidentialité à partir de cette archive.

Mettre en œuvre l'autorisation et l'authentification

Lorsque votre application Conducteur génère et envoie des mises à jour au backend Fleet Engine, les demandes doivent inclure des jetons d'accès valides. Pour autoriser et authentifie ces requêtes, le SDK Driver appelle votre conformément à la GMTDAuthorization standard. L'objet est chargé de fournir le jeton d'accès requis.

En tant que développeur de l'application, vous choisissez la façon dont les jetons sont générés. Votre implémentation doit permettre d'effectuer les opérations suivantes:

• Extrayez un jeton d'accès, éventuellement au format JSON, à partir d'un serveur HTTPS.
• Analyser et mettre en cache le jeton.
• Actualisez le jeton lorsqu'il expire.

Pour en savoir plus sur les jetons attendus par le serveur Fleet Engine, consultez Créer un jeton Web JSON (JWT) pour l'autorisation

L'ID du fournisseur est identique à l'ID du projet Google Cloud. Consultez le guide de l'utilisateur de l'API Fleet Engine Deliveries. pour en savoir plus.

L'exemple suivant met en œuvre un fournisseur de jetons d'accès:

#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

Créer une instance DeliveryDriverAPI

Pour obtenir une instance GMTDDeliveryVehicleReporter, vous devez d'abord créer un GMTDDeliveryDriverAPI à l'aide des commandes providerID, vehicleID, driverContext et accessTokenProvider. providerID est identique à ID du projet Google Cloud. Et vous pouvez accéder à GMTDDeliveryVehicleReporter directement à partir de l'API du pilote.

L'exemple suivant crée une instance GMTDDeliveryDriverAPI:

#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];
}

Écouter les événements VehicleReporter (facultatif)

GMTDDeliveryVehicleReporter met régulièrement à jour le véhicule lorsque locationTrackingEnabled est "OUI". Pour répondre à ces mises à jour périodiques, peut s'abonner aux événements GMTDDeliveryVehicleReporter en respectant le protocole GMTDVehicleReporterListener.

Vous pouvez gérer les événements suivants:

• vehicleReporter:didSucceedVehicleUpdate

  Informe l'application pilote que les services de backend ont bien reçu le mise à jour de la position et de l'état du véhicule

• vehicleReporter:didFailVehicleUpdate:withError

  Informe l'écouteur qu'une mise à jour du véhicule a échoué. Tant que la localisation le suivi est activé, GMTDDeliveryVehicleReporter continue d'envoyer le les plus récentes vers le backend Fleet Engine.

L'exemple suivant gère ces événements:

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

Activer le suivi de la position

Pour activer le suivi de la position, votre application peut définir locationTrackingEnabled sur YES le GMTDDeliveryVehicleReporter. Puis GMTDDeliveryVehicleReporter envoie automatiquement des notifications de position. Lorsque GMSNavigator est en cours de navigation mode (quand une destination est définie via setDestinations) et "locationTrackingEnabled" est défini sur "YES", GMTDDeliveryVehicleReporter envoie automatiquement des mises à jour de l'itinéraire et de l'heure d'arrivée prévue.

L'itinéraire défini lors de ces mises à jour est le même que celui emprunté par le conducteur d'accéder pendant la session de navigation. Pour que le suivi du parc fonctionne, correctement, le point de cheminement défini dans -setDestinations:callback: doit correspondre la destination définie dans le backend Fleet Engine.

L'exemple suivant active le suivi de la position:

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

Par défaut, l'intervalle de rapport est de 10 secondes, mais il peut être modifié par locationUpdateInterval. Intervalle minimal de mise à jour accepté est de 5 secondes. L'intervalle de mise à jour maximal accepté est de 60 secondes. Plus fréquente les mises à jour peuvent ralentir les requêtes et provoquer des erreurs.

Désactiver les mises à jour de la position et mettre le véhicule hors connexion

Votre application peut désactiver les mises à jour de la position d'un véhicule. Par exemple, lorsqu'un fin de journée de travail du conducteur, votre application peut définir locationTrackingEnabled sur NO.

  _vehicleReporter.locationTrackingEnabled = NO