Driver SDK adalah library yang Anda integrasikan ke dalam aplikasi driver. Penting bertanggung jawab untuk memperbarui Fleet Engine dengan lokasi pengemudi, rute, jarak yang tersisa, dan PWT. SDK 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 sudah mengimplementasikan kode Navigation SDK dan Fleet Engine backend disiapkan dan tersedia. Namun, kode contoh menyediakan contoh cara menyiapkan Navigation SDK.
Anda juga harus mengaktifkan Maps SDK for iOS di Project Google Cloud Anda dan pilih Mendapatkan Kunci API.
Pengembangan lokal
Untuk pengembangan lokal, 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)
Menyiapkan host otomatisasi sesuai dengan praktik terbaik:
Jika proses Anda berjalan di dalam lingkungan Google Cloud, gunakan otomatis deteksi kredensial.
Jika tidak, simpan file kunci akun layanan di lokasi yang aman pada sistem file {i>host<i} dan mengatur GOOGLE_APPLICATION_CREDENTIALS variabel lingkungan dengan tepat.
Email akun layanan yang terkait dengan kredensial harus merupakan anggota Google Workspace.
Konfigurasi Project
Swift Package Manager
Driver SDK dapat diinstal melalui Swift Package Manager. Untuk menambahkan SDK, pastikan Anda memiliki menghapus semua dependensi Driver SDK yang ada.
Untuk menambahkan SDK ke project baru atau yang sudah ada, ikuti langkah-langkah berikut:
-
Buka
project
atauworkspace
Xcode, lalu buka File > Menambahkan Dependensi Paket. - Masukkan https://github.com/googlemaps/ios-driver-sdk sebagai URL, tekan Enter untuk menarik paket, dan klik "{i>Add Package<i}".
-
Untuk menginstal
version
tertentu, setel kolom Dependency Rule ke salah satu opsi berbasis versi. Untuk proyek baru, sebaiknya tentukan versi terbaru dan menggunakan "Versi Persis" sebelumnya. Setelah selesai, klik "Add Package". -
Dari jendela Choose Package Products, pastikan
GoogleRidesharingDriver
akan ditambahkan ke targetmain
yang Anda tetapkan. Setelah selesai, klik "Add Package". -
Untuk memverifikasi penginstalan, buka panel
General
target Anda. Di Frameworks, Libraries, and Embedded Content, Anda akan melihat paket yang diinstal. Anda juga dapat melihat "{i>Package Dependencies<i}" bagian "Navigator Proyek" untuk memverifikasi paket dan versinya.
Untuk mengupdate package
untuk project yang sudah ada, ikuti langkah-langkah berikut:
Jika mengupgrade dari versi yang lebih lama dari 9.0.0, Anda harus menghapus dependensi berikut:
GoogleMapsBase
,GoogleMapsCore
, danGoogleMapsM4B
setelah mengupgrade. Jangan hapus dependensi untukGoogleMaps
. Untuk informasi selengkapnya, lihat Catatan Rilis Versi 9.0.0.Dari setelan konfigurasi proyek Xcode Anda, temukan Frameworks, Libraries, dan Konten yang Disematkan. Gunakan tanda minus(-) untuk menghapus framework berikut:
GoogleMapsBase
(Hanya untuk upgrade dari versi sebelum 9.0.0)GoogleMapsCore
(Hanya untuk upgrade dari versi sebelum 9.0.0)GoogleMapsM4B
(Hanya untuk upgrade dari versi sebelum 9.0.0)
- Dari Xcode, buka "File > Paket > Update Ke Versi Paket Terbaru".
- Untuk memverifikasi penginstalan, buka bagian Package Dependencies Project Navigator untuk memverifikasi paket dan versinya.
Untuk menghapus dependensi Driver SDK yang ada yang ditambahkan menggunakan
CocoaPods
, ikuti langkah berikut:
- Tutup ruang kerja Xcode Anda. Buka terminal dan jalankan perintah berikut:
sudo gem install cocoapods-deintegrate cocoapods-clean pod deintegrate pod cache clean --all
-
Hapus
Podfile
,Podfile.resolved
, dan Xcodeworkspace
jika Anda tidak menggunakannya untuk hal apa pun selain CocoaPods.
Untuk menghapus Driver SDK yang sudah terinstal secara manual, ikuti langkah-langkah berikut:
Dari setelan konfigurasi project Xcode, temukan Frameworks, Library, dan Konten Tersemat. Gunakan tanda minus
(-)
untuk menghapus kerangka kerja berikut ini:GoogleRidesharingDriver.xcframework
Dari direktori level teratas project Xcode Anda, hapus Paket
GoogleRidesharingDriver
.
CocoaPods
Untuk mengonfigurasi Driver SDK menggunakan CocoaPods, Anda memerlukan item berikut:
- Alat CocoaPods: Untuk menginstal alat ini, buka Terminal dan jalankan perintah berikut.
sudo gem install cocoapods
Buat Podfile untuk Driver SDK dan gunakan untuk menginstal API dan 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 dan buka direktori yang berisi Podfile:
cd <path-to-project>
Jalankan perintah pod install. Ini akan menginstal API yang ditetapkan dalam Podfile, beserta dependensi apa pun yang mungkin dimilikinya.
pod install
Tutup Xcode, lalu buka (klik dua kali) .xcworkspace project Anda untuk meluncurkan Xcode. Mulai saat ini dan seterusnya, Anda harus menggunakan file .xcworkspace untuk membuka proyek.
Lihat CocoaPods Memulai untuk informasi selengkapnya spesifikasi pendukung.
Penginstalan manual
XCFramework adalah paket biner yang Anda gunakan untuk menginstal Driver SDK. Anda dapat menggunakan paket ini di beberapa platform ini, termasuk komputer yang menggunakan aplikasi Apple silikon. Panduan ini menunjukkan cara menambahkan secara manual XCFramework yang berisi Driver SDK ke project dan mengonfigurasi build Anda di Xcode.
Download resource dan biner SDK:
Ekstrak file tersebut untuk mengakses XCFramework dan resource.
Mulai Xcode dan buka project yang ada, atau buat project baru proyek. Jika Anda baru menggunakan iOS, buat project baru dan pilih Template aplikasi.
Buat grup Kerangka Kerja di bawah grup proyek Anda jika belum ada .
Untuk menginstal Driver SDK, tarik
GoogleRidesharingDriver.xcframework
ke project Anda di bagian Framework, Library, dan Konten Tersemat. Saat diminta, pilih Salin item jika perlu.Tarik
GoogleRidesharingDriver.bundle
yang didownload ke level teratas project Xcode Anda. Saat diminta, pilihCopy items if needed
.Pilih proyek Anda dari Navigator Proyek, 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, dan buka fungsi Build Setelan kami. Di bagian Other Linker Flags, tambahkan
-ObjC
untuk debug dan rilis. Jika setelan ini tidak terlihat, ubah pada panel Setelan Build dari Dasar ke Semua.
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 mengotorisasi dan
yang mengotentikasi permintaan ini, Driver SDK memanggil objek yang sesuai dengan
GMTDAuthorization
dan berperforma tinggi
karena merupakan protokol biner. Objek ini bertanggung jawab untuk menyediakan token akses yang diperlukan.
Sebagai developer aplikasi, Anda memilih bagaimana token dibuat. Implementasi 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 ID Project 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 terlebih dahulu membuat instance
GMTDDeliveryDriverAPI
menggunakan providerID,
VehicleID, driverContext, dan accessTokenProvider. providerID sama dengan
ID Project Google Cloud. Dan Anda dapat mengakses 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
mengupdate kendaraan secara berkala saat
locationTrackingEnabled
adalah YA. Untuk menanggapi pembaruan berkala ini,
objek dapat berlangganan peristiwa GMTDDeliveryVehicleReporter
dengan mematuhi
protokol GMTDVehicleReporterListener
.
Anda dapat menangani peristiwa berikut:
vehicleReporter:didSucceedVehicleUpdate
Memberi tahu aplikasi Driver bahwa layanan backend berhasil menerima lokasi kendaraan dan pembaruan negara bagian.
vehicleReporter:didFailVehicleUpdate:withError
Memberi tahu pemroses bahwa update kendaraan gagal. Selama lokasi pelacakan diaktifkan,
GMTDDeliveryVehicleReporter
akan terus mengirimkan 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
pada GMTDDeliveryVehicleReporter
. Maka GMTDDeliveryVehicleReporter
akan =
otomatis mengirimkan pembaruan lokasi. Saat GMSNavigator
sedang melakukan navigasi
mode (saat tujuan ditetapkan melalui setDestinations
) dan
locationTrackingEnabled
disetel ke YES
, GMTDDeliveryVehicleReporter
akan
otomatis mengirim pembaruan rute
dan PWT juga.
Rute yang ditetapkan selama pembaruan tersebut akan sama dengan rute yang dilalui pengemudi
bernavigasi selama sesi navigasi. Sehingga, agar pelacakan pengiriman berfungsi
dengan benar, titik jalan yang ditetapkan melalui -setDestinations:callback:
harus cocok dengan
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. Lebih sering
update dapat mengakibatkan error dan permintaan yang lebih lambat.
Menonaktifkan pembaruan lokasi
Aplikasi Anda dapat menonaktifkan pembaruan lokasi untuk kendaraan. Misalnya, ketika seorang
shift pengemudi berakhir, aplikasi Anda dapat menetapkan locationTrackingEnabled
ke NO
.
_vehicleReporter.locationTrackingEnabled = NO
Menangani error update_mask
Saat GMTDDeliveryVehicleReporter
mengirim update kendaraan, update_mask
bisa terjadi saat mask kosong, dan biasanya terjadi dalam
update 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