Anda dapat menggunakan Driver SDK untuk memberikan navigasi dan pelacakan yang ditingkatkan pada aplikasi Progres Perjalanan dan Pesanan. Driver SDK menyediakan lokasi kendaraan dan pembaruan tugas untuk On-demand Solution Fleet Engine.
Driver SDK membuat layanan Fleet Engine dan layanan kustom Anda mengetahui
lokasi dan status kendaraan. Misalnya, kendaraan dapat berupa ONLINE
atau OFFLINE
, dan lokasi kendaraan berubah saat perjalanan berlangsung.
Persyaratan sistem minimum
Prasyarat
Panduan ini mengasumsikan bahwa aplikasi Anda sudah mengimplementasikan Navigation SDK dan bahwa backend Fleet Engine sudah disiapkan dan tersedia. Namun, kode contoh ini memberikan contoh cara menyiapkan Navigation SDK.
Anda juga harus mengaktifkan Maps SDK for iOS di Project Google Cloud dan Mendapatkan Kunci API.
Konfigurasi Project
Anda dapat mengonfigurasi Driver SDK menggunakan CocoaPods.
Menggunakan CocoaPods
Untuk mengonfigurasi Driver SDK menggunakan CocoaPods, Anda memerlukan item berikut:
- Alat CocoaPods: Untuk menginstal alat ini, buka Terminal dan jalankan perintah berikut.
shell sudo gem install cocoapods
Lihat panduan Memulai CocoaPods untuk mengetahui detail selengkapnya.
Buat Podfile untuk Driver SDK dan gunakan untuk menginstal API beserta dependensinya: Buat file bernama Podfile di direktori project Anda. File ini mendefinisikan dependensi project Anda. Edit Podfile dan tambahkan dependensi Anda. Berikut adalah contoh yang menyertakan dependensi:
source "https://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' end
Berikut adalah contoh yang menyertakan pod Alfa dan Beta untuk Driver SDK sebagai dependensi:
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
Simpan Podfile. Buka terminal, lalu arahkan ke direktori yang berisi Podfile:
cd <path-to-project>
Jalankan perintah pod install. Tindakan ini akan menginstal API yang ditentukan di Podfile, beserta dependensi apa pun yang mungkin dimiliki.
pod install
Tutup Xcode, lalu buka (klik dua kali) file .xcworkspace project Anda untuk meluncurkan Xcode. Mulai saat ini dan seterusnya, Anda harus menggunakan file .xcworkspace untuk membuka project.
Versi SDK Alfa/Beta
Untuk mengonfigurasi Driver SDK for iOS versi Alfa atau Beta, Anda memerlukan item berikut:
Alat CocoaPods: Untuk menginstal alat ini, buka Terminal dan jalankan perintah berikut.
sudo gem install cocoapods
Baca panduan Memulai CocoaPods untuk mengetahui detail selengkapnya.
Akun pengembangan Anda di daftar akses Google. Repositori pod SDK versi Alfa dan Beta bukanlah sumber publik. Untuk mengakses versi tersebut, hubungi Customer Engineer di Google. Engineer akan menambahkan akun pengembangan Anda ke daftar akses, lalu menetapkan cookie untuk autentikasi.
Setelah project masuk dalam daftar akses, Anda dapat mengakses pod.
Buat Podfile untuk Delivery SDK for iOS dan gunakan untuk menginstal API beserta dependensinya: Buat file bernama Podfile di direktori project Anda. File ini mendefinisikan dependensi project Anda. Edit Podfile dan tambahkan dependensi Anda. Berikut adalah contoh yang menyertakan dependensi:
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
Simpan Podfile. Buka terminal, lalu arahkan ke direktori yang berisi Podfile:
cd <path-to-project>
Jalankan perintah pod install. Perintah ini menginstal API yang ditentukan di Podfile, beserta dependensi apa pun yang mungkin dimiliki.
pod install
Tutup Xcode, lalu buka (klik dua kali) file .xcworkspace project Anda untuk meluncurkan Xcode. Mulai saat ini dan seterusnya, Anda harus menggunakan file .xcworkspace untuk membuka project.
Menerapkan otorisasi dan autentikasi
Saat aplikasi Driver Anda membuat dan mengirim update ke backend Fleet Engine,
permintaan tersebut harus menyertakan token akses yang valid. Untuk mengizinkan dan
mengautentikasi permintaan ini, Driver SDK akan memanggil objek Anda sesuai dengan
protokol
GMTDAuthorization
. Objek bertanggung jawab untuk menyediakan token akses yang diperlukan.
Sebagai developer aplikasi, Anda memilih cara token dibuat. Penerapan Anda akan memberikan kemampuan untuk melakukan hal berikut:
- Ambil token akses, mungkin dalam format JSON, dari server HTTPS.
- Mengurai dan meng-cache token.
- Muat ulang token jika masa berlakunya habis.
Untuk detail tentang token yang diharapkan oleh server Fleet Engine, lihat Membuat Token Web JSON (JWT) untuk otorisasi.
ID penyedia sama dengan ID Project Google Cloud. Lihat Panduan Memulai Armada untuk informasi selengkapnya.
Contoh berikut menerapkan penyedia token akses:
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
Membuat instance RidesharingDriverAPI
Untuk mendapatkan instance GMTDVehicleReporter
, Anda harus membuat
instance GMTDRidesharingDriverAPI
terlebih dahulu menggunakan providerID,
vehicleID, driverContext, dan accessTokenProvider. providerID sama dengan
ID Project Google Cloud. Anda juga dapat mengakses instance GMTDVehicleReporter
dari Driver API secara langsung.
Contoh berikut membuat instance 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];
}
Secara opsional, memproses peristiwa VehicleReporter
GMTDVehicleReporter
memperbarui kendaraan secara berkala saat locationTrackingEnabled
adalah true
. Untuk merespons update berkala ini, setiap objek dapat berlangganan peristiwa GMTDVehicleReporter
dengan mematuhi protokol GMTDVehicleReporterListener
.
Anda dapat menangani peristiwa berikut:
vehicleReporter(_:didSucceed:)
Memberi tahu Aplikasi pengemudi bahwa layanan backend berhasil menerima pembaruan status dan lokasi kendaraan.
vehicleReporter(_:didFail:withError:)
Memberi tahu pemroses bahwa update kendaraan gagal. Selama pelacakan lokasi diaktifkan,
GMTDVehicleReporter
akan terus mengirim data terbaru ke backend Fleet Engine.
Contoh berikut menangani peristiwa ini:
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
Menambahkan GMTDvehicleReporter sebagai pemroses ke GMSRoadSnappedLocationProvider
Untuk memberikan pembaruan lokasi ke Driver SDK, GMTDVehicleReporter
harus ditetapkan sebagai pemroses ke 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
Aktifkan pelacakan lokasi
Untuk mengaktifkan pelacakan lokasi, aplikasi Anda dapat menetapkan locationTrackingEnabled
ke true
pada GMTDVehicleReporter
. GMTDVehicleReporter
mengirimkan pembaruan lokasi secara otomatis.
Setelah layanan cocok dan menetapkan kendaraan ke sebuah perjalanan, GMTDVehicleReporter
akan otomatis mengirimkan pembaruan rute saat GMSNavigator
dalam mode navigasi (saat
tujuan ditetapkan melalui setDestinations
).
Rute yang ditetapkan selama pembaruan perjalanan akan menjadi rute yang sama dengan yang dilalui pengemudi
selama sesi navigasi.
Dengan demikian, agar berbagi perjalanan berfungsi dengan baik, titik jalan yang ditetapkan melalui
setDestinations
harus cocok dengan tujuan yang ditetapkan di backend Fleet Engine.
Jika locationTrackingEnabled
ditetapkan ke true
, update
perjalanan dan kendaraan akan dikirim ke backend Fleet Engine pada interval reguler
berdasarkan nilai yang ditetapkan untuk locationUpdateInterval
. Jika
locationTrackingEnabled
ditetapkan ke false
, update akan berhenti
dan permintaan update kendaraan akhir akan dikirim ke backend Fleet Engine untuk menetapkan
status kendaraan ke GMTDVehicleState.offline
.
Lihat updateVehicleState
untuk pertimbangan khusus tentang penanganan kegagalan saat locationTrackingEnabled
ditetapkan ke false
.
Contoh berikut mengaktifkan pelacakan lokasi:
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
Secara default, interval pelaporan adalah 10 detik, tetapi interval pelaporan dapat
diubah dengan locationUpdateInterval
. Interval update minimum yang didukung
adalah 5 detik. Interval update maksimum yang didukung adalah 60 detik. Update yang lebih sering
dapat menyebabkan permintaan dan error yang lebih lambat.
Perbarui status kendaraan
Contoh berikut menunjukkan cara menetapkan status kendaraan ke ONLINE
.
Lihat updateVehicleState
untuk mengetahui detailnya.
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
Error update_mask
dapat terjadi saat mask kosong, dan biasanya terjadi
untuk update pertama setelah startup. Contoh berikut menunjukkan cara menangani
error ini:
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
Nonaktifkan pembaruan lokasi dan buat kendaraan offline
Aplikasi Anda dapat menonaktifkan update dan membuat kendaraan offline. Misalnya, saat shift pengemudi berakhir, aplikasi Anda dapat menetapkan locationTrackingEnabled
ke false
. Menonaktifkan
update juga akan menetapkan status kendaraan menjadi OFFLINE
di backend Fleet Engine.
Swift
vehicleReporter.locationTrackingEnabled = false
Objective-C
_vehicleReporter.locationTrackingEnabled = NO;