Driver SDK adalah library yang Anda integrasikan ke dalam aplikasi pengemudi. Library ini bertanggung jawab untuk mengupdate Fleet Engine dengan lokasi kendaraan, rute, jarak tersisa, dan PWT. Alat ini juga terintegrasi dengan Navigation SDK, yang menyediakan petunjuk navigasi belokan demi belokan bagi pengemudi.
Persyaratan sistem minimum
Prasyarat
Panduan ini mengasumsikan bahwa aplikasi Anda telah menerapkan Navigation SDK dan backend Fleet Engine telah disiapkan dan tersedia. Namun, kode contoh memberikan contoh cara menyiapkan Navigation SDK.
Anda juga harus mengaktifkan Maps SDK for iOS di Project Google Cloud dan Mendapatkan Kunci API.
Dapatkan akses
Jika Anda adalah pelanggan Google Workspace, buat
Grup Workspace seperti
google-maps-platform-sdk-users@workspacedomain.com
selama orientasi dan
beri nama kepada Google. Ini adalah pendekatan yang direkomendasikan.
Grup Workspace Anda kemudian akan ditambahkan ke daftar yang diizinkan yang
memberikan akses ke repositori CocoaPods yang benar. Pastikan email pengguna dan email akun layanan yang memerlukan akses sudah tercantum dalam daftar ini.
Jika organisasi Anda tidak dapat membuat Grup Workspace, kirimkan daftar email pengguna dan akun layanan yang memerlukan akses ke artefak ini ke Google.
Pengembangan lokal
Untuk pengembangan lokal, Anda cukup login dengan Cloud SDK.
gcloud
gcloud auth login
Email yang digunakan untuk login harus merupakan anggota Grup Workspace.
Otomatisasi (sistem build atau continuous integration)
Siapkan host otomatisasi sesuai dengan praktik terbaik:
Jika proses Anda berjalan di dalam lingkungan Google Cloud, gunakan deteksi kredensial otomatis.
Jika tidak, simpan file kunci akun layanan di lokasi yang aman pada sistem file host dan tetapkan variabel lingkungan GOOGLE_APPLICATION_CREDENTIALS dengan tepat.
Email akun layanan yang terkait dengan kredensial harus merupakan anggota Grup Workspace.
Konfigurasi Project
Anda dapat mengonfigurasi Driver SDK untuk iOS menggunakan Cocoapods atau secara manual.
Gunakan Cocoapods
Untuk mengonfigurasi Driver SDK untuk iOS, 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 detail selengkapnya.
Buat Podfile untuk Driver SDK untuk 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://github.com/CocoaPods/Specs.git" target 'YOUR_APPLICATION_TARGET_NAME_HERE' do pod 'GoogleRidesharingDriver' end
Simpan Podfile. Buka terminal, lalu buka direktori yang berisi Podfile:
cd <path-to-project>
Jalankan perintah pod install. Tindakan ini akan menginstal API yang ditentukan di Podfile, beserta dependensi yang mungkin dimilikinya.
pod install
Tutup Xcode, lalu buka (klik dua kali) file .xcworkspace project Anda untuk menjalankan Xcode. Mulai saat ini, Anda harus menggunakan file .xcworkspace untuk membuka project.
Menginstal XCFramework
Download resource dan biner SDK:
XCFramework adalah paket biner yang Anda gunakan untuk menginstal Driver SDK. Anda dapat menggunakan paket ini di beberapa platform, termasuk mesin yang menggunakan chipset M1. Panduan ini menunjukkan cara menambahkan XCFramework yang berisi Driver SDK secara manual ke project Anda dan mengonfigurasi setelan build di Xcode.
Ekstrak file zip untuk mengakses XCFramework dan resource.
Mulai Xcode dan buka project yang ada, atau buat project baru. Jika Anda baru menggunakan iOS, buat project baru lalu pilih template Aplikasi iOS.
Buat grup Framework di bawah grup proyek Anda jika belum ada.
Tarik file
gRPCCertificates.bundle
yang didownload ke direktori level teratas project Xcode Anda. Saat diminta, pilih Salin item jika diperlukan.Untuk menginstal Driver SDK, tarik file
GoogleRidesharingDriver.xcframework
ke project Anda di bagian Frameworks, Libraries, and Embedded Content. Saat diminta, pilih Salin item jika diperlukan.Tarik
GoogleRidesharingDriver.bundle
yang telah didownload ke direktori level teratas project Xcode Anda. Saat diminta, pilihCopy items if needed
.Pilih project Anda dari Navigator Project, dan pilih target aplikasi Anda.
Buka tab Build Phases, dan di Link Binary with Libraries, tambahkan framework dan library berikut jika belum ada:
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
Pilih project Anda, bukan target tertentu, lalu buka tab Build Settings. Di bagian Other Linker Flags, tambahkan
‑ObjC
untuk debug dan rilis. Jika setelan ini tidak terlihat, ubah filter di panel Setelan Build dari Dasar menjadi Semua.
Versi SDK Alfa/Beta
Untuk mengonfigurasi versi Alfa atau Beta Driver SDK untuk iOS, Anda memerlukan item berikut:
Alat CocoaPods: Untuk menginstal alat ini, buka Terminal dan jalankan perintah berikut.
sudo gem install cocoapods
Lihat Panduan Memulai CocoaPods untuk detail selengkapnya.
Akun pengembangan Anda di daftar akses Google. Repositori pod SDK versi Alfa dan Beta bukan sumber publik. Untuk mengakses versi tersebut, hubungi Google Customer Engineer. Engineer menambahkan akun pengembangan Anda ke daftar akses, lalu menyetel cookie untuk autentikasi.
Setelah project berada dalam daftar akses, Anda dapat mengakses pod.
Buat Podfile untuk Driver SDK untuk 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 buka direktori yang berisi Podfile:
cd <path-to-project>
Jalankan perintah pod install. Perintah ini menginstal API yang ditentukan di Podfile, beserta dependensi yang mungkin dimilikinya.
pod install
Tutup Xcode, lalu buka (klik dua kali) file .xcworkspace project Anda untuk menjalankan Xcode. Mulai saat ini, Anda harus menggunakan file .xcworkspace untuk membuka project.
Memeriksa file Manifes Privasi Apple
Apple mewajibkan detail privasi aplikasi untuk aplikasi di App Store. Kunjungi halaman Detail Privasi Apple App Store untuk pembaruan dan informasi selengkapnya.
File Manifes Privasi Apple disertakan dalam paket resource untuk SDK. Untuk memverifikasi bahwa File Manifes Privasi telah disertakan, dan untuk memeriksa kontennya, buat arsip aplikasi dan buat laporan privasi dari arsip.
Menerapkan otorisasi dan autentikasi
Saat aplikasi Driver Anda membuat dan mengirim update ke backend Fleet Engine, permintaan harus menyertakan token akses yang valid. Untuk memberi otorisasi dan mengautentikasi permintaan ini, Driver SDK memanggil objek yang sesuai dengan protokol GMTDAuthorization
. Objek ini bertanggung jawab untuk menyediakan token akses yang diperlukan.
Sebagai developer aplikasi, Anda memilih cara token dibuat. Penerapan Anda harus memberikan kemampuan untuk melakukan hal berikut:
- Ambil token akses, kemungkinan dalam format JSON, dari server HTTPS.
- Uraikan dan simpan token dalam cache.
- Muat ulang token jika masa berlakunya sudah habis.
Untuk detail tentang token yang diharapkan oleh server Fleet Engine, lihat Membuat Token Web JSON (JWT) untuk otorisasi.
ID penyedia sama dengan Project ID Google Cloud. Lihat Panduan Pengguna Fleet Engine Deliveries API untuk informasi selengkapnya.
Contoh berikut menerapkan penyedia token akses:
#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
Membuat instance DeliveryDriverAPI
Untuk mendapatkan instance GMTDDeliveryVehicleReporter
, Anda harus membuat instance GMTDDeliveryDriverAPI
terlebih dahulu menggunakan providerID
, vehicleID
, driverContext
, dan accessTokenProvider
. providerID
sama dengan Project ID Google Cloud. Anda juga dapat mengakses instance GMTDDeliveryVehicleReporter
dari API driver secara langsung.
Contoh berikut membuat instance 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];
}
Mendengarkan peristiwa VehicleReporter (opsional)
GMTDDeliveryVehicleReporter
secara berkala memperbarui kendaraan jika
locationTrackingEnabled
adalah YA. Untuk merespons update berkala ini, objek apa pun dapat berlangganan peristiwa GMTDDeliveryVehicleReporter
dengan sesuai dengan protokol GMTDVehicleReporterListener
.
Anda dapat menangani peristiwa berikut:
vehicleReporter:didSucceedVehicleUpdate
Memberi tahu aplikasi Pengemudi bahwa layanan backend berhasil menerima pembaruan lokasi dan status kendaraan.
vehicleReporter:didFailVehicleUpdate:withError
Memberi tahu pemroses bahwa update kendaraan gagal. Selama pelacakan lokasi diaktifkan,
GMTDDeliveryVehicleReporter
akan terus mengirim data terbaru ke backend Fleet Engine.
Contoh berikut menangani peristiwa ini:
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
Aktifkan pelacakan lokasi
Untuk mengaktifkan pelacakan lokasi, aplikasi Anda dapat menetapkan locationTrackingEnabled
ke YES
di GMTDDeliveryVehicleReporter
. Selanjutnya, GMTDDeliveryVehicleReporter
akan otomatis mengirim pembaruan lokasi. Saat GMSNavigator
dalam mode navigasi (saat tujuan ditetapkan melalui setDestinations
) dan
locationTrackingEnabled
ditetapkan ke YES
, GMTDDeliveryVehicleReporter
juga akan otomatis mengirim pembaruan rute dan PWT.
Rute yang ditetapkan selama pembaruan tersebut adalah rute yang sama dengan yang dituju pengemudi
selama sesi navigasi. Dengan demikian, agar pelacakan perangkat berfungsi dengan benar, titik jalan yang ditetapkan melalui -setDestinations:callback:
harus cocok dengan tujuan yang ditetapkan di backend Fleet Engine.
Contoh berikut mengaktifkan pelacakan lokasi:
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
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.
Nonaktifkan pembaruan lokasi dan buat kendaraan offline
Aplikasi Anda dapat menonaktifkan pembaruan lokasi untuk kendaraan. Misalnya, saat
shift pengemudi berakhir, aplikasi Anda dapat menyetel locationTrackingEnabled
ke NO
.
_vehicleReporter.locationTrackingEnabled = NO