Cómo comenzar a usar el SDK del controlador para iOS

El SDK de Driver es una biblioteca que integras en la app del conductor. Es responsable de actualizar Fleet Engine con la ubicación, la ruta, la distancia restante y la hora de llegada estimada del conductor. También se integra en el SDK de Navigation, que proporciona instrucciones de navegación paso a paso para el conductor.

Requisitos mínimos del sistema

  • El dispositivo móvil debe ejecutar iOS 13 o una versión posterior.
  • La versión 14 de Xcode o una posterior
  • Requisitos previos

    En esta guía, se supone que tu app ya implementa el SDK de Navigation y que el backend de Fleet Engine está configurado y disponible. Sin embargo, el código de ejemplo proporciona un ejemplo de cómo configurar el SDK de Navigation.

    También debes habilitar el SDK de Maps para iOS en tu proyecto de Google Cloud y obtener una clave de API.

    Obtén acceso

    Si eres cliente de Google Workspace, crea un grupo de Workspace como google-maps-platform-sdk-users@workspacedomain.com durante la integración y proporciona el nombre a Google. Este es el método recomendado. Tu grupo de Workspace se agregará a una lista de entidades permitidas que otorga acceso a los repositorios correctos de CocoaPods. Confirma que los correos electrónicos de los usuarios y de la cuenta de servicio que necesitan acceso se incluyan en esta lista.

    Si tu organización no puede crear grupos de lugares de trabajo, envía a Google una lista de correos electrónicos de cuentas de usuario y de servicio que necesitan acceso a estos artefactos.

    Desarrollo local

    Para el desarrollo local, basta con acceder con el SDK de Cloud.

    gcloud

    gcloud auth login
    

    El correo electrónico que se use para acceder debe ser miembro del grupo de Workspace.

    Automatización (sistemas de compilación o integración continua)

    Configura tus hosts de automatización de acuerdo con las prácticas recomendadas:

    • Si tu proceso se ejecuta dentro de un entorno de Google Cloud, usa la detección de credenciales automática.

    • De lo contrario, almacena el archivo de claves de la cuenta de servicio en una ubicación segura en el sistema de archivos del host y configura la variable de entorno GOOGLE_APPLICATION_CREDENTIALS de forma adecuada.

    El correo electrónico de la cuenta de servicio asociado con las credenciales debe ser miembro del grupo de lugar de trabajo.

    Configuración del proyecto

    Puedes configurar el SDK del controlador usando CocoaPods.

    Mediante CocoaPods

    Para configurar el SDK del controlador utilizando CocoaPods, necesitas los siguientes elementos:

    • La herramienta CocoaPods: para instalarla, abre la terminal y ejecuta el siguiente comando. shell sudo gem install cocoapods Consulta la guía de introducción de CocoaPods para obtener más detalles.
    1. Crea un Podfile para el SDK de Driver y úsalo para instalar la API y sus dependencias. Crea un archivo llamado Podfile en el directorio de tu proyecto. Este archivo define las dependencias de tu proyecto. Edita el Podfile y agrega tus dependencias. Este es un ejemplo que incluye las dependencias:

      source "https://github.com/CocoaPods/Specs.git"
      
      target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
        pod 'GoogleRidesharingDriver'
      end
      
    2. Guarda el Podfile. Abre una terminal y ve al directorio que contiene el Podfile:

      cd <path-to-project>
      
    3. Ejecuta el comando de instalación del Pod. Con esta acción, se instalarán las APIs especificadas en el Podfile, junto con las dependencias que contengan.

      pod install
      
    4. Cierra Xcode y, con un doble clic, abre el archivo .xcworkspace de tu proyecto para iniciar Xcode. A partir de este momento, debes usar el archivo .xcworkspace para abrir el proyecto.

    Versiones del SDK Alfa y Beta

    Para configurar las versiones Alfa o Beta del SDK de Driver para iOS, necesitas los siguientes elementos:

    • La herramienta CocoaPods: para instalarla, abre la terminal y ejecuta el siguiente comando.

      sudo gem install cocoapods
      

      Consulta la guía de introducción de CocoaPods para obtener más detalles.

    • Tu cuenta de desarrollo en la lista de acceso de Google El repositorio de Pods de las versiones Alfa y Beta del SDK no es de fuente pública. Para acceder a esas versiones, comunícate con el Ingeniero de Atención al cliente de Google. El ingeniero agrega tu cuenta de desarrollo a la lista de acceso y, luego, establece una cookie para la autenticación.

    Una vez que tu proyecto esté en la lista de acceso, podrás acceder al Pod.

    1. Crea un Podfile para el SDK de Driver para iOS y úsalo para instalar la API y sus dependencias. Para ello, crea un archivo llamado Podfile en el directorio de tu proyecto. Este archivo define las dependencias de tu proyecto. Edita el Podfile y agrega tus dependencias. Este es un ejemplo que incluye las dependencias:

      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. Guarda el Podfile. Abre una terminal y ve al directorio que contiene el Podfile:

      cd <path-to-project>
      
    3. Ejecuta el comando de instalación del Pod. Con esta acción, se instalarán las APIs especificadas en el Podfile, junto con las dependencias que contengan.

      pod install
      
    4. Cierra Xcode y, con un doble clic, abre el archivo .xcworkspace de tu proyecto para iniciar Xcode. A partir de este momento, debes usar el archivo .xcworkspace para abrir el proyecto.

    Instala el XCFramework

    Un XCFramework es un paquete binario que usas para instalar el SDK de Driver. Puedes usar este paquete en varias plataformas, incluidas las máquinas que usan el chipset M1. Esta guía muestra cómo agregar manualmente el XCFramework que contiene el SDK de Driver a tu proyecto y configurar los ajustes de tu compilación en Xcode.

    Descarga el objeto binario y los recursos del SDK:

    1. Descomprime los archivos comprimidos para acceder al XCFramework y los recursos.

    2. Inicia Xcode y abre un proyecto existente o crea uno nuevo. Si es la primera vez que usas iOS, crea un proyecto nuevo y selecciona la plantilla de la app para iOS.

    3. Crea un grupo de Frameworks en tu grupo de proyecto si aún no hay uno.

    4. Arrastra el archivo gRPCCertificates.bundle descargado al directorio de nivel superior de tu proyecto de Xcode. Cuando se te solicite, selecciona Copiar elementos si es necesario.

    5. Para instalar el SDK de Driver, arrastra el archivo GoogleRidesharingDriver.xcframework a tu proyecto en Frameworks, bibliotecas y contenido incorporado. Cuando se te solicite, selecciona Copiar elementos si es necesario.

    6. Arrastra el archivo GoogleRidesharingDriver.bundle descargado al directorio de nivel superior de tu proyecto de Xcode. Cuando se te solicite, selecciona Copy items if needed.

    7. Selecciona tu proyecto en el navegador de proyectos y elige el destino de tu aplicación.

    8. Abre la pestaña Build Phases y, en Link Binary with Libraries, agrega los siguientes frameworks y bibliotecas si aún no están presentes:

      • 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. Elige tu proyecto, en lugar de un destino específico, y abre la pestaña Build Settings. En la sección Other Linker Flags, agrega ‑ObjC para la depuración y el lanzamiento. Si estos parámetros de configuración no son visibles, cambia el filtro de la barra de Configuración de compilación de Básico a Todos.

    Implementa la autorización y autenticación

    Cuando tu app de Driver genera y envía actualizaciones al backend de Fleet Engine, las solicitudes deben incluir tokens de acceso válidos. Para autorizar y autenticar estas solicitudes, el SDK de Driver llama a tu objeto de acuerdo con el protocolo GMTDAuthorization. El objeto es responsable de proporcionar el token de acceso requerido.

    Como desarrollador de la app, tú eliges cómo se generan los tokens. Tu implementación debe proporcionar la capacidad de hacer lo siguiente:

    • Recupera un token de acceso, posiblemente en formato JSON, desde un servidor HTTPS.
    • Analiza y almacena el token en caché.
    • Actualiza el token cuando venza.

    Para obtener detalles de los tokens que espera el servidor de Fleet Engine, consulta Crea un token web JSON (JWT) para la autorización.

    El ID del proveedor es el mismo que el ID del proyecto de Google Cloud. Consulta la Guía del usuario de la API de entregas de Fleet Engine para obtener más información.

    En el siguiente ejemplo, se implementa un proveedor de tokens de acceso:

    #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
    

    Crea una instancia de DeliveryDriverAPI

    Para obtener una instancia de GMTDDeliveryVehicleReporter, primero debes crear una instancia de GMTDDeliveryDriverAPI con providerID,vehicleID, driveContext y accessTokenProvider. El providerID es el mismo que el ID del proyecto de Google Cloud. Además, puedes acceder a la instancia GMTDDeliveryVehicleReporter directamente desde la API del controlador.

    En el siguiente ejemplo, se crea una instancia de 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];
    }
    

    De manera opcional, escucha eventos VehicleReporter

    GMTDDeliveryVehicleReporter actualiza el vehículo de forma periódica cuando el valor de locationTrackingEnabled es SÍ. Para responder a estas actualizaciones periódicas, cualquier objeto puede suscribirse a eventos GMTDDeliveryVehicleReporter de acuerdo con el protocolo GMTDVehicleReporterListener.

    Puedes controlar los siguientes eventos:

    • vehicleReporter:didSucceedVehicleUpdate

      Informa a la app de conductor que los servicios de backend recibieron correctamente la ubicación y la actualización de estado del vehículo.

    • vehicleReporter:didFailVehicleUpdate:withError

      Informa al objeto de escucha que falló una actualización del vehículo. Siempre que el seguimiento de ubicación esté habilitado, GMTDDeliveryVehicleReporter seguirá enviando los datos más recientes al backend de Fleet Engine.

    En el siguiente ejemplo, se controlan estos eventos:

    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
    

    Habilita el seguimiento de ubicación

    Para habilitar el seguimiento de ubicación, la app puede configurar locationTrackingEnabled como YES en GMTDDeliveryVehicleReporter. Luego, GMTDDeliveryVehicleReporter enviará actualizaciones de ubicación automáticamente. Cuando GMSNavigator está en el modo de navegación (cuando un destino se establece a través de setDestinations) y locationTrackingEnabled se establece en YES, GMTDDeliveryVehicleReporter también enviará automáticamente actualizaciones de ruta y hora de llegada estimada.

    La ruta establecida durante esas actualizaciones será la misma a la que navega el conductor durante la sesión de navegación. Por lo tanto, para que el seguimiento de envíos funcione de forma correcta, el punto de referencia establecido a través de -setDestinations:callback: debe coincidir con el conjunto de destinos en el backend de Fleet Engine.

    En el siguiente ejemplo, se habilita el seguimiento de ubicación:

    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
    

    De forma predeterminada, el intervalo de informes es de 10 segundos, pero el intervalo de informes se puede cambiar con locationUpdateInterval. El intervalo de actualización mínimo admitido es de 5 segundos. El intervalo de actualización máximo admitido es de 60 segundos. Las actualizaciones más frecuentes pueden generar solicitudes y errores más lentos.

    Inhabilitar las actualizaciones de ubicación

    Tu app puede inhabilitar las actualizaciones de ubicación para un vehículo. Por ejemplo, cuando finaliza el turno de un conductor, tu app puede establecer locationTrackingEnabled en NO.

      _vehicleReporter.locationTrackingEnabled = NO
    

    Cómo administrar errores update_mask

    Cuando GMTDDeliveryVehicleReporter envía una actualización del vehículo, puede producirse un error update_mask cuando la máscara está vacía. Por lo general, esto ocurre durante la primera actualización después del inicio. En el siguiente ejemplo, se muestra cómo manejar este error:

    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