El SDK del controlador es una biblioteca que integras en tu app del controlador. Sí de actualizar la flota con la ubicación, la ruta, distancia restante y ETA. También se integra con el SDK de Navigation, proporciona instrucciones de navegación paso a paso para el conductor.
Requisitos mínimos del sistema
Requisitos previos
En esta guía, se da por sentado que tu app ya implementa el SDK de Navigation y que las Fleet Engine de que el backend 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 obtén una clave de API.
Desarrollo local
Para el desarrollo local, basta con acceder con el SDK de Cloud.
gcloud
gcloud auth login
El correo electrónico que uses para acceder debe ser de un miembro del grupo de Workspace.
Automatización (sistemas de compilación o integración continua)
Configura los hosts de automatización según Prácticas recomendadas:
Si tu proceso se ejecuta dentro de un entorno de Google Cloud, usa automático la detección de credenciales.
De lo contrario, almacena el archivo de claves de la cuenta de servicio en una ubicación segura del del sistema de archivos del host y configurar GOOGLE_APPLICATION_CREDENTIALS variable de entorno adecuada.
El correo electrónico de la cuenta de servicio asociado con las credenciales debe ser miembro de del grupo de Workspace.
Configuración de proyectos
Swift Package Manager
El SDK del controlador se puede instalar a través de Swift Package Manager. Para agregar el SDK, asegúrate de haber quitaste las dependencias existentes del SDK de Driver.
Para agregar el SDK a un proyecto nuevo o existente, sigue estos pasos:
-
Abre tu Xcode
project
oworkspace
y, luego, ve a Archivo > Agrega dependencias de paquetes. - Ingresa https://github.com/googlemaps/ios-driver-sdk como URL y presiona Intro. para extraer el paquete y haz clic en "Add Package".
-
Para instalar un
version
específico, establece el campo Dependency Rule en una de las siguientes opciones: las opciones basadas en la versión. Para los proyectos nuevos, recomendamos especificar la versión más reciente y usando la "Versión exacta" de 12 a 1 con la nueva opción de compresión. Cuando termines, haz clic en "Add Package". -
En la ventana Choose Package Products, verifica que se agregará
GoogleRidesharingDriver
a tu objetivomain
designado. Cuando termines, haz clic en "Add Package". -
Para verificar la instalación, navega al panel
General
de tu destino. En Frameworks, bibliotecas y contenido incorporado, deberías ver los paquetes instalados. También puedes ver las dependencias de paquetes de "Project Navigator" para verificar el paquete y su versión.
Para actualizar el package
de un proyecto existente, sigue estos pasos:
Si actualizas desde una versión anterior a la 9.0.0, debes quitar las siguientes dependencias:
GoogleMapsBase
,GoogleMapsCore
yGoogleMapsM4B
después de la actualización. No quites la dependencia paraGoogleMaps
Para obtener más información, consulta la Notas de la versión 9.0.0Desde los ajustes de configuración del proyecto Xcode, busca Frameworks, Libraries, y Contenido Incorporado. Usa el signo menos(-) para quitar el siguiente marco de trabajo:
GoogleMapsBase
(solo para actualizaciones de versiones anteriores a la 9.0.0)GoogleMapsCore
(solo para actualizaciones de versiones anteriores a la 9.0.0)GoogleMapsM4B
(solo para actualizaciones de versiones anteriores a la 9.0.0)
- Desde Xcode, ve a “Archivo > Paquetes > Update To Last Package Versions”.
- Para verificar la instalación, ve a la sección Package Dependencies de Project Navigator. para verificar el paquete y su versión.
Para quitar las dependencias existentes del SDK de Driver que se agregaron con
CocoaPods
, sigue estos pasos:
- Cierra tu espacio de trabajo de Xcode. Abre la terminal y ejecuta el siguiente comando:
sudo gem install cocoapods-deintegrate cocoapods-clean pod deintegrate pod cache clean --all
-
Quita el
Podfile
, elPodfile.resolved
y el Xcodeworkspace
si no los usas para nada que no sea CocoaPods.
Quita el SDK de Driver existente que está instalado manualmente, sigue estos pasos:
Desde los ajustes de configuración del proyecto Xcode, busca Frameworks, Bibliotecas y Contenido Incorporado Usa el signo menos
(-)
para quitarlo el siguiente framework:GoogleRidesharingDriver.xcframework
Desde el directorio de nivel superior de tu proyecto de Xcode, quita el elemento Paquete de
GoogleRidesharingDriver
.
CocoaPods
Para configurar el SDK del controlador con CocoaPods, necesitas los siguientes elementos:
- La herramienta CocoaPods: para instalar esta herramienta, abre la terminal y ejecuta el siguiente comando.
sudo gem install cocoapods
Crea un Podfile para el SDK del controlador 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
Este es un ejemplo que incluye los Pods Alfa y Beta para la SDK del controlador 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' end
Guarda el Podfile. Abre una terminal y ve al directorio que contiene los Podfile:
cd <path-to-project>
Ejecuta el comando pod install. Esto instalará las APIs especificadas en el Podfile, junto con las dependencias que puedan tener.
pod install
Cierra Xcode y, luego, abre (con doble clic) el .xcworkspace de tu proyecto para iniciar Xcode. A partir de este momento, debes usar la .xcworkspace para abrir el proyecto.
Consulta los primeros pasos de CocoaPods guía para obtener más información más detalles.
Instalación manual
Un XCFramework es un paquete binario que usas para instalar el SDK de Driver. Puedes usar este paquete en varias plataformas, incluidas máquinas que usan Apple Silicon. En esta guía, se muestra cómo agregar manualmente el XCFramework que contiene los SDK de Driver para tu proyecto y configurar la compilación en Xcode.
Descarga el objeto binario y los recursos del SDK:
Extrae los archivos para acceder a XCFramework y los recursos.
Inicia Xcode y abre un proyecto existente o crea uno nuevo en un proyecto final. Si es la primera vez que usas iOS, crea un proyecto nuevo y selecciona el Plantilla de app.
Crear un grupo de marcos de trabajo en tu grupo de proyecto si no existe uno que ya existe.
Para instalar el SDK del controlador, arrastra la
GoogleRidesharingDriver.xcframework
en tu proyecto en Frameworks, bibliotecas y contenido incorporado. Cuando se te solicite, selecciona Copia los elementos si es necesario.Arrastra el archivo
GoogleRidesharingDriver.bundle
descargado al nivel superior de tu proyecto de Xcode. Cuando se te solicite, seleccionaCopy items if needed
.Selecciona tu proyecto en el navegador de proyectos y elige el destino de tu aplicación.
Abre la pestaña Build Fases y, en Link Binary with Libraries, agrega el 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
Elige tu proyecto, en lugar de un destino específico, y abre la sección Build Configuración. En la sección Other Linker Flags, agrega
-ObjC
para depurar y lanzar. Si esta configuración no está visible, cambia el filtrar en la barra Build Settings de Basic a All.
Cómo inspeccionar el archivo de manifiesto de privacidad de Apple
Apple requiere los detalles de privacidad de las apps que se encuentran en la App Store. Visita la página de detalles de privacidad de la App Store de Apple para obtener actualizaciones y más información.
El archivo de manifiesto de privacidad de Apple se incluye en el paquete de recursos del SDK. Para verificar que se haya incluido el archivo de manifiesto de privacidad y para inspeccionar su contenido, crea un archivo de tu app y genera un informe de privacidad a partir del archivo.
Implementa la autorización y la 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 del controlador llama a tu objeto de conformidad con
GMTDAuthorization
protocolo. El objeto es responsable de proporcionar el token de acceso requerido.
Como desarrollador de la app, 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 en caché el token.
- Actualiza el token cuando venza.
Para obtener más información sobre los tokens que espera el servidor de Fleet Engine, consulta Crear un token web JSON (JWT) para 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 Flet Engine Deliveries. 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 GMTDDeliveryVehicleReporter
, primero debes crear una
Una instancia de GMTDDeliveryDriverAPI
con el providerID,
trafficID, driveContext y accessTokenProvider. El providerID es el mismo que
ID del proyecto de Google Cloud. Y puedes acceder a GMTDDeliveryVehicleReporter
directamente desde la API del controlador.
En el siguiente ejemplo, se crea una instancia 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];
}
Opcionalmente, escucha eventos de VehicleReporter
GMTDDeliveryVehicleReporter
actualiza el vehículo periódicamente cuando
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 del controlador que los servicios de backend recibieron correctamente el la ubicación del vehículo y la actualización de estado.
vehicleReporter:didFailVehicleUpdate:withError
Informa al objeto de escucha que falló una actualización del vehículo. Siempre y cuando la ubicación seguimiento habilitado,
GMTDDeliveryVehicleReporter
continúa enviando el 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
Habilitar el seguimiento de ubicación
Para habilitar el seguimiento de ubicación, la app puede establecer locationTrackingEnabled
en YES
el GMTDDeliveryVehicleReporter
. Entonces, GMTDDeliveryVehicleReporter
=
enviar actualizaciones de ubicación automáticamente. Cuando GMSNavigator
está en navegación
(cuando se configura un destino a través de setDestinations
)
locationTrackingEnabled
se estableció en YES
; GMTDDeliveryVehicleReporter
también puede enviar automáticamente actualizaciones de la ruta y la hora de llegada estimada.
La ruta establecida durante esas actualizaciones será la misma ruta que utiliza el conductor
durante la sesión de navegación. Por lo tanto, para que el seguimiento del envío funcione,
correctamente, 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 del informe es de 10 segundos, pero
se 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. Más frecuente
las actualizaciones pueden hacer que las solicitudes y los errores sean más lentos.
Cómo inhabilitar las actualizaciones de ubicación
Tu app puede inhabilitar las actualizaciones de ubicación de un vehículo. Por ejemplo, cuando un
finaliza la turnos del conductor, tu app puede establecer locationTrackingEnabled
en NO
.
_vehicleReporter.locationTrackingEnabled = NO
Cómo controlar errores de update_mask
Cuando GMTDDeliveryVehicleReporter
envía una actualización del vehículo, se produce un update_mask
puede ocurrir cuando la máscara está vacía y, por lo general, ocurre en los primeros
se actualicen 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