Puedes usar el SDK de Driver para mejorar la navegación y el seguimiento de tu aplicación de Progreso de viaje y pedido. El SDK de Driver proporciona actualizaciones de tareas y ubicación del vehículo a On-demand Rides and Deliveries Solution Fleet Engine.
El SDK de Driver mantiene a los servicios de Fleet Engine y tus servicios personalizados al tanto de la ubicación y el estado del vehículo. Por ejemplo, el vehículo puede ser ONLINE o OFFLINE, y la ubicación del vehículo cambia a medida que avanza el viaje.
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 una muestra 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.
Configuración del proyecto
Puedes configurar el SDK del controlador usando CocoaPods.
Mediante CocoaPods
Para configurar el SDK del controlador usando CocoaPods, necesitas los siguientes elementos:
- La herramienta CocoaPods: Para instalar esta herramienta, abre la terminal y ejecuta el
siguiente comando.
shell sudo gem install cocoapodsConsulta la guía de introducción de CocoaPods para obtener más detalles.
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' endA continuación, se muestra un ejemplo que incluye los pods Alfa y Beta para el SDK de Driver como 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' endGuarda el Podfile. Abre una terminal y ve al directorio que contiene el Podfile:
cd <path-to-project>Ejecuta el comando pod install. De esta manera, se instalarán las APIs especificadas en el Podfile, junto con las dependencias que puedan contener.
pod installCierra Xcode y, luego, abre (con doble clic) 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/beta
A fin de configurar las versiones Alfa o Beta del SDK de Driver para iOS, necesitas los siguientes elementos:
La herramienta CocoaPods: Para instalar esta herramienta, abre la terminal y ejecuta el siguiente comando.
sudo gem install cocoapodsConsulta 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, configura una cookie para la autenticación.
Una vez que tu proyecto esté en la lista de acceso, podrás acceder al Pod.
Crea un Podfile para el SDK de Delivery para iOS 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://cpdc-eap.googlesource.com/ridesharing-driver-sdk.git" source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' endGuarda el Podfile. Abre una terminal y ve al directorio que contiene el Podfile:
cd <path-to-project>Ejecuta el comando pod install. Con este comando, se instalan las APIs especificadas en el Podfile junto con las dependencias que contengan.
pod installCierra Xcode y, luego, abre (con doble clic) el archivo .xcworkspace de tu proyecto para iniciar Xcode. A partir de este momento, debes usar el archivo .xcworkspace para abrir el proyecto.
Implementa la autorización y autenticación
Cuando tu app de controlador 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:
- Obtén un token de acceso, posiblemente en formato JSON, desde un servidor HTTPS.
- Analiza y almacena en caché el token.
- 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 de inicio rápido de Fleet Engine para obtener más información.
En el siguiente ejemplo, se implementa un proveedor de tokens de acceso:
Swift
import GoogleRidesharingDriver
private let providerURL = "INSERT_YOUR_TOKEN_PROVIDER_URL"
class SampleAccessTokenProvider: NSObject, GMTDAuthorization {
private struct AuthToken {
// The cached vehicle token.
let token: String
// Keep track of when the token expires for caching.
let expiration: TimeInterval
// Keep track of the vehicle ID the cached token is for.
let vehicleID: String
}
enum AccessTokenError: Error {
case missingAuthorizationContext
case missingData
}
private var authToken: AuthToken?
func fetchToken(
with authorizationContext: GMTDAuthorizationContext?,
completion: @escaping GMTDAuthTokenFetchCompletionHandler
) {
// Get the vehicle ID from the authorizationContext. This is set by the Driver SDK.
guard let authorizationContext = authorizationContext else {
completion(nil, AccessTokenError.missingAuthorizationContext)
return
}
let vehicleID = authorizationContext.vehicleID
// If appropriate, use the cached token.
if let authToken = authToken,
authToken.expiration > Date.now.timeIntervalSince1970 && authToken.vehicleID == vehicleID
{
completion(authToken.token, nil)
return
}
// Otherwise, try to fetch a new token from your server.
let request = URLRequest(url: URL(string: providerURL))
let task = URLSession.shared.dataTask(with: request) { [weak self] data, _, error in
guard let strongSelf = self else { return }
guard error == nil else {
completion(nil, error)
return
}
// Replace the following key values with the appropriate keys based on your
// server's expected response.
let vehicleTokenKey = "VEHICLE_TOKEN_KEY"
let tokenExpirationKey = "TOKEN_EXPIRATION"
guard let data = data,
let fetchData = try? JSONSerialization.jsonObject(with: data) as? [String: Any],
let token = fetchData[vehicleTokenKey] as? String,
let expiration = fetchData[tokenExpirationKey] as? Double
else {
completion(nil, AccessTokenError.missingData)
return
}
strongSelf.authToken = AuthToken(
token: token, expiration: expiration, vehicleID: vehicleID)
completion(token, nil)
}
task.resume()
}
}
Objective‑C
#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 {
// 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 vehicletoken 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 la API de RidesharingDriverAPI
Para obtener una instancia de GMTDVehicleReporter, primero debes crear una instancia de GMTDRidesharingDriverAPI con los 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 de GMTDVehicleReporter directamente desde la API del controlador.
En el siguiente ejemplo, se crea una instancia de GMTDRidesharingDriverAPI:
Swift
import GoogleRidesharingDriver
private let providerID = "INSERT_YOUR_PROVIDER_ID"
class SampleViewController: UIViewController {
private let mapView: GMSMapView
override func viewDidLoad() {
super.viewDidLoad()
let vehicleID = "INSERT_CREATED_VEHICLE_ID"
let accessTokenProvider = SampleAccessTokenProvider()
let driverContext = GMTDDriverContext(
accessTokenProvider: accessTokenProvider,
providerID: providerID,
vehicleID: vehicleID,
navigator: mapView.navigator)
let ridesharingDriverAPI = GMTDRidesharingDriverAPI(driverContext: driverContext)
}
}
Objective‑C
#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];
GMTDRidesharingDriverAPI *ridesharingDriverAPI = [[GMTDRidesharingDriverAPI alloc] initWithDriverContext:driverContext];
}
De forma opcional, escucha eventos VehicleReporter
GMTDVehicleReporter actualiza el vehículo de forma periódica cuando locationTrackingEnabled es true. Para responder a estas actualizaciones periódicas, cualquier objeto puede suscribirse a eventos GMTDVehicleReporter de acuerdo con el protocolo GMTDVehicleReporterListener.
Puedes controlar los siguientes eventos:
vehicleReporter(_:didSucceed:)Informa a la app del conductor que los servicios de backend recibieron de forma correcta la ubicación del vehículo y la actualización de estado.
vehicleReporter(_:didFail:withError:)Informa al objeto de escucha que falló una actualización del vehículo. Siempre que el seguimiento de ubicación esté habilitado,
GMTDVehicleReporterseguirá enviando los datos más recientes al backend de Fleet Engine.
En el siguiente ejemplo, se controlan estos eventos:
Swift
import GoogleRidesharingDriver
private let providerID = "INSERT_YOUR_PROVIDER_ID"
class SampleViewController: UIViewController, GMTDVehicleReporterListener {
private let mapView: GMSMapView
override func viewDidLoad() {
// Assumes you have implemented the sample code up to this step.
ridesharingDriverAPI.vehicleReporter.add(self)
}
func vehicleReporter(_ vehicleReporter: GMTDVehicleReporter, didSucceed vehicleUpdate: GMTDVehicleUpdate) {
// Handle update succeeded.
}
func vehicleReporter(_ vehicleReporter: GMTDVehicleReporter, didFail vehicleUpdate: GMTDVehicleUpdate, withError error: Error) {
// Handle update failed.
}
}
Objective‑C
/*
* 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 have implemented the sample code up to this step.
[ridesharingDriverAPI.vehicleReporter addListener:self];
}
- (void)vehicleReporter:(GMTDVehicleReporter *)vehicleReporter didSucceedVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate {
// Handle update succeeded.
}
- (void)vehicleReporter:(GMTDVehicleReporter *)vehicleReporter didFailVehicleUpdate:(GMTDVehicleUpdate *)vehicleUpdate withError:(NSError *)error {
// Handle update failed.
}
@end
Se agregó GMTDVehicleReporter como objeto de escucha para GMSRoadSnappedLocationProvider.
Para proporcionar actualizaciones de ubicación al SDK de Driver, se debe configurar GMTDVehicleReporter como un objeto de escucha de GMSRoadSnappedLocationProvider.
Swift
import GoogleRidesharingDriver
private let providerID = "INSERT_YOUR_PROVIDER_ID"
class SampleViewController: UIViewController, GMTDVehicleReporterListener {
private let mapView: GMSMapView
override func viewDidLoad() {
// Assumes you have implemented the sample code up to this step.
if let roadSnappedLocationProvider = mapView.roadSnappedLocationProvider {
roadSnappedLocationProvider.add(ridesharingDriverAPI.vehicleReporter)
roadSnappedLocationProvider.startUpdatingLocation()
}
}
}
Objective‑C
/*
* 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 have implemented the sample code up to this step.
[_mapView.roadSnappedLocationProvider addListener:ridesharingDriverAPI.vehicleReporter];
[_mapView.roadSnappedLocationProvider startUpdatingLocation];
}
@end
Habilitar el seguimiento de la ubicación
Para habilitar el seguimiento de ubicación, la app puede configurar locationTrackingEnabled como true en GMTDVehicleReporter. GMTDVehicleReporter envía actualizaciones de ubicación automáticamente.
Una vez que los servicios coinciden y asignan el vehículo a un viaje, GMTDVehicleReporter envía actualizaciones de ruta automáticamente cuando GMSNavigator está en modo de navegación (cuando se establece un destino mediante setDestinations).
La ruta establecida durante la actualización del viaje será la misma que utiliza el conductor durante la sesión de navegación.
Por lo tanto, para que el uso compartido del recorrido funcione correctamente, el punto de referencia establecido a través de setDestinations debe coincidir con el destino establecido en el backend de Fleet Engine.
Si locationTrackingEnabled se configura como true, las actualizaciones de viaje y vehículo se envían al backend de Fleet Engine a intervalos regulares según el valor establecido para locationUpdateInterval. Si locationTrackingEnabled se configura como false, las actualizaciones se detienen y se envía una solicitud de actualización final del vehículo al backend de Fleet Engine para establecer el estado del vehículo en GMTDVehicleState.offline.
Consulta updateVehicleState para obtener consideraciones especiales sobre el manejo de fallas cuando locationTrackingEnabled se establece en false.
En el siguiente ejemplo, se habilita el seguimiento de ubicación:
Swift
import GoogleRidesharingDriver
private let providerID = "INSERT_YOUR_PROVIDER_ID"
class SampleViewController: UIViewController, GMTDVehicleReporterListener {
private let mapView: GMSMapView
override func viewDidLoad() {
// Assumes you have implemented the sample code up to this step.
ridesharingDriverAPI.vehicleReporter.locationTrackingEnabled = true
}
}
Objective‑C
/*
* 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 have implemented the sample code up to this step.
ridesharingDriverAPI.vehicleReporter.locationTrackingEnabled = YES;
}
@end
De forma predeterminada, el intervalo de informes es de 10 segundos, pero 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 provocar solicitudes más lentas y errores.
Actualiza el estado del vehículo
En el siguiente ejemplo, se muestra cómo establecer el estado del vehículo en ONLINE.
Consulta updateVehicleState para obtener más detalles.
Swift
import GoogleRidesharingDriver
private let providerID = "INSERT_YOUR_PROVIDER_ID"
class SampleViewController: UIViewController, GMTDVehicleReporterListener {
private let mapView: GMSMapView
override func viewDidLoad() {
// Assumes you have implemented the sample code up to this step.
ridesharingDriverAPI.vehicleReporter.update(.online)
}
}
Objective‑C
#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 have implemented the sample code up to this step.
[ridesharingDriverAPI.vehicleReporter
updateVehicleState:GMTDVehicleStateOnline];
}
@end
Se puede producir un error update_mask cuando la máscara está vacía y, por lo general, ocurre durante la primera actualización después del inicio. En el siguiente ejemplo, se muestra cómo solucionar 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
Inhabilitar las actualizaciones de ubicación y desconectar el vehículo
Tu app puede inhabilitar las actualizaciones y desconectar el vehículo. Por ejemplo, cuando finaliza el turno de un conductor, tu app puede establecer locationTrackingEnabled en false. Si inhabilitas las actualizaciones, también se establece el estado del vehículo como OFFLINE en el backend de Fleet Engine.
Swift
vehicleReporter.locationTrackingEnabled = false
Objective‑C
_vehicleReporter.locationTrackingEnabled = NO;