Memulai Driver SDK untuk iOS

Driver SDK adalah library yang Anda integrasikan ke dalam aplikasi driver. Penting bertanggung jawab untuk memperbarui Fleet Engine dengan lokasi kendaraan, 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.

Dapatkan akses

Jika Anda adalah pelanggan Google Workspace, buat Workspace Group seperti google-maps-platform-sdk-users@workspacedomain.com selama orientasi dan memberikan nama ke Google. Ini adalah pendekatan yang direkomendasikan. Grup Workspace Anda kemudian akan ditambahkan ke daftar yang diizinkan yang memberikan akses ke repositori CocoaPods yang benar. Konfirmasikan bahwa pengguna dan email akun layanan yang memerlukan akses akan disertakan dalam daftar ini.

Jika organisasi Anda tidak dapat membuat Grup Workspace, kirim daftar ke Google email pengguna dan akun layanan yang membutuhkan akses ke artefak ini.

Pengembangan lokal

Untuk pengembangan lokal, cukup login dengan Cloud SDK.

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 Grup Workspace.

Konfigurasi Project

Anda dapat mengonfigurasi Driver SDK untuk iOS menggunakan Cocoapods atau secara manual.

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 untuk mengautentikasi permintaan ini, Driver SDK akan 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 cara 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 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 terlebih dahulu membuat instance 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. Setelah itu GMTDDeliveryVehicleReporter otomatis mengirimkan pembaruan lokasi. Saat GMSNavigator sedang melakukan navigasi mode (saat tujuan ditetapkan melalui setDestinations) dan locationTrackingEnabled disetel ke YES, GMTDDeliveryVehicleReporter otomatis mengirimkan pembaruan rute dan PWT juga.

Rute yang ditetapkan selama pembaruan tersebut adalah rute yang sama dengan yang dilalui pengemudi bernavigasi selama sesi navigasi. Sehingga, agar pelacakan perangkat 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.

Nonaktifkan pembaruan lokasi dan buat kendaraan offline

Aplikasi Anda dapat menonaktifkan pembaruan lokasi untuk kendaraan. Misalnya, ketika seorang shift pengemudi berakhir, aplikasi Anda dapat menetapkan locationTrackingEnabled ke NO.

  _vehicleReporter.locationTrackingEnabled = NO