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

El SDK de Driver es una biblioteca que integras en tu app de conductores. Es responsable de actualizar Fleet Engine con la ubicación del vehículo, la ruta, la distancia restante y la hora de llegada estimada. 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

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 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 de proyectos

Puedes configurar el SDK de Driver para iOS con CocoaPods o de forma manual.

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, driverContext 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 mediante setDestinations) y locationTrackingEnabled se establece en YES, GMTDDeliveryVehicleReporter también envía automáticamente actualizaciones de ruta y hora de llegada estimada.

La ruta establecida durante esas actualizaciones es la misma a la que navega el conductor durante la sesión de navegación. Por lo tanto, para que el seguimiento de flotas funcione de forma correcta, el punto de referencia establecido a través de -setDestinations:callback: debe coincidir con el destino establecido 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 y desconectar el vehículo

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