ラストワンマイルのフリートソリューションは現在、一部のお客様のみご利用いただけます。詳しくは、営業担当者までお問い合わせください。

このページは Cloud Translation API によって翻訳されました。

Driver SDK for iOS のスタートガイド

注: LMFS の機能には、Driver SDK で使用するセキュリティモデルとして、信頼できないモデルと信頼できるモデルの 2 つが用意されています。untrusteduntrustedどちらのセキュリティモデルも、ドライバーアプリが車両データの更新を Fleet Engine に提供する方法を定義しています。信頼できないセキュリティモデルでは、ドライバーアプリからのデータチェックの追加レイヤが提供されます。信頼できないモデルでは、ドライバーアプリは車両の位置情報の更新のみを Fleet Engine に直接送信できます。信頼できないドライバーアプリからのその他の車両データの更新はすべて、お客様のバックエンドに送信する必要があります。バックエンドはデータを Fleet Engine にリレーします。

信頼できるセキュリティモデルにより、ドライバーアプリは、仲介サービスを必要とせずに車両データの更新を Fleet Engine に直接送信できます。このデータには、車両、タスク、停車地の作成と更新の両方が含まれます。

信頼できないモデルは一般提供されていますが、信頼できるドライバモデルはプレビュー版です。信頼できるドライバモデルの詳細については、他のサービスアカウントのロールをご覧ください。

Driver SDK は、ドライバアプリに統合するライブラリです。ドライバーの位置、ルート、残りの距離、到着予定時刻で Fleet Engine を更新します。また、ターンバイターン方式のナビをドライバーに提供する Navigation SDK とも統合されています。

最小システム要件

モバイルデバイスに iOS 14 以降が搭載されている必要があります。

Xcode バージョン 14 以降。

前提条件

このガイドでは、アプリに Navigation SDK がすでに実装されており、Fleet Engine バックエンドが設定され、使用可能であることを前提としています。ただし、サンプルコードでは、Navigation SDK のセットアップ方法のサンプルを用意しています。

また、Google Cloud プロジェクトで Maps SDK for iOS を有効にし、API キーを取得する必要があります。

アクセスの取得

Google Workspace を使用している場合は、オンボーディング時に google-maps-platform-sdk-users@workspacedomain.com などの Workspace グループを作成し、その名前を Google に提供します。これはおすすめの方法です。正しい CocoaPods リポジトリへのアクセス権を付与する許可リストにワークスペースグループが追加されます。アクセス権が必要なユーザーのメールアドレスとサービスアカウントのメールアドレスがこのリストに含まれていることを確認します。

組織で Workspace グループを作成できない場合は、これらのアーティファクトにアクセスする必要があるユーザーとサービスアカウントのメールアドレスのリストを Google に送信します。

ローカルでの開発

ローカル開発の場合は、Cloud SDK でログインするだけで十分です。

gcloud

gcloud auth login

ログインに使用するメールアドレスは、Workspace グループのメンバーである必要があります。

自動化（ビルドシステムまたは継続的インテグレーション）

ベストプラクティスに従って自動化ホストを設定します。

プロセスが Google Cloud 環境内で実行されている場合は、認証情報の自動検出を使用します。
それ以外の場合は、ホストのファイルシステム上の安全な場所にサービスアカウントキーファイルを保存し、GOOGLE_APPLICATION_CREDENTIALS 環境変数を適切に設定します。

認証情報に関連付けられたサービスアカウントのメールアドレスは、Workspace Goup のメンバーである必要があります。

Project Configuration

CocoaPods を使用して Driver SDK を構成できます。

CocoaPods を使用

CocoaPods を使用して Driver SDK を構成するには、次のものが必要です。

CocoaPods ツール: このツールをインストールするには、ターミナルを開いて次のコマンドを実行します。shell sudo gem install cocoapods 詳しくは、CocoaPods スタートガイドをご覧ください。

Driver SDK の Podfile を作成し、それを使用して API とその依存関係をインストールします。プロジェクトディレクトリに Podfile という名前のファイルを作成します。このファイルでプロジェクトの依存関係を定義します。Podfile を編集して、依存関係を追加します。依存関係を含む例を次に示します。
```
source "https://github.com/CocoaPods/Specs.git"

target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
  pod 'GoogleRidesharingDriver'
end
```
注: 必ず pod outdated を定期的に実行して、SDK の新しいバージョンの有無を検出するようにしてください。詳細については、Driver SDK for iOS バージョンをご覧ください。
注: プロジェクトにフレームワークの使用を必要とする依存関係がある場合は、gRPC Pod の依存関係に静的リンクを指定する必要があります。これは、use_frameworks 構成を使用してターゲットレベルで行うか、gRPC Pod に個別に静的リンクを適用することで行うことができます。そうしないと、実行時に missing roots.pem gRPC エラーが発生する可能性があります。
Podfile を保存します。ターミナルを開き、Podfile があるディレクトリに移動します。
```
cd <path-to-project>
```
pod install コマンドを実行します。これにより、Podfile で指定された API と、その依存関係がインストールされます。
```
pod install
```
Xcode を終了し、プロジェクトの .xcworkspace ファイルを開いて（ダブルクリックして）Xcode を起動します。これ以降は、.xcworkspace ファイルを使用してプロジェクトを開く必要があります。

アルファ版/ベータ版 SDK バージョン

Driver SDK for iOS のアルファ版またはベータ版を構成するには、次のものが必要です。

CocoaPods ツール: このツールをインストールするには、ターミナルを開いて次のコマンドを実行します。
```
sudo gem install cocoapods
```
詳しくは、CocoaPods スタートガイドをご覧ください。
Google アクセスリストに登録されている開発アカウント。SDK のアルファ版とベータ版の Pod リポジトリは、公開ソースではありません。これらのバージョンにアクセスするには、Google カスタマーエンジニアにお問い合わせください。エンジニアが開発用アカウントをアクセスリストに追加し、認証用の Cookie を設定します。

プロジェクトがアクセスリストに登録すると、Pod にアクセスできるようになります。

Driver SDK for iOS の Podfile を作成し、それを使用して API とその依存関係をインストールします。プロジェクトディレクトリに Podfile という名前のファイルを作成します。このファイルでプロジェクトの依存関係を定義します。Podfile を編集して、依存関係を追加します。依存関係を含む例を次に示します。
```
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
```
Podfile を保存します。ターミナルを開き、Podfile があるディレクトリに移動します。
```
cd <path-to-project>
```
pod install コマンドを実行します。これにより、Podfile で指定された API と、その依存関係がインストールされます。
```
pod install
```
Xcode を終了し、プロジェクトの .xcworkspace ファイルを開いて（ダブルクリックして）Xcode を起動します。これ以降は、.xcworkspace ファイルを使用してプロジェクトを開く必要があります。

XCFramework をインストールする

XCFramework は、Driver SDK のインストールに使用するバイナリパッケージです。このパッケージは、M1 チップセットを搭載したマシンなど、複数のプラットフォームで使用できます。このガイドでは、Driver SDK を含む XCFramework をプロジェクトに手動で追加し、Xcode でビルド設定を構成する方法について説明します。

SDK のバイナリとリソースをダウンロードします。

圧縮したファイルを解凍して、XCFramework とリソースにアクセスします。
Xcode を起動し、既存のプロジェクトを開くか、新しいプロジェクトを作成します。iOS を初めて使用する場合は、新しいプロジェクトを作成し、iOS App テンプレートを選択します。
フレームワークグループが存在しない場合は、プロジェクトグループにフレームワークグループを作成します。
ダウンロードした gRPCCertificates.bundle ファイルを Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[必要に応じてコピー] を選択します。
Driver SDK をインストールするには、[Frameworks, Libraries, and Embedded Content] に GoogleRidesharingDriver.xcframework ファイルをドラッグします。プロンプトが表示されたら、[必要に応じてコピー] を選択します。
ダウンロードした GoogleRidesharingDriver.bundle を Xcode プロジェクトの最上位ディレクトリにドラッグします。プロンプトが表示されたら、[Copy items if needed] を選択します。
Project Navigator のプロジェクトを選択し、アプリのターゲットを選択します。
[Build Phases] タブを開き、[Link Binary with Libraries] で、次のフレームワークとライブラリを追加します（まだ存在しない場合）。
- 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
特定のターゲットではなくプロジェクトを選択し、[Build Settings] タブを開きます。[Other Linker Flags] セクションで、デバッグ用とリリース用の両方に ‑ObjC を追加します。これらの設定が表示されない場合は、ビルド設定バーのフィルタを [Basic] から [All] に変更します。

認可と認証を実装する

ドライバアプリが更新を生成して Fleet Engine バックエンドに送信する場合、リクエストに有効なアクセストークンを含める必要があります。これらのリクエストを承認して認証するために、Driver SDK は GMTDAuthorization プロトコルに従ってオブジェクトを呼び出します。オブジェクトは、必要なアクセストークンを提供する役割を担います。

トークンの生成方法はアプリデベロッパーが選択できます。実装では、次の機能を提供する必要があります。

HTTPS サーバーからアクセストークンを（JSON 形式で取得できる）取得します。
トークンを解析してキャッシュに保存します。
トークンの有効期限が切れたら更新する。

Fleet Engine サーバーで想定されるトークンの詳細については、認可用の JSON Web Token（JWT）の作成をご覧ください。

プロバイダ ID は Google Cloud プロジェクト ID と同じです。詳しくは、Fleet Engine Deliveries API ユーザーガイドをご覧ください。

次の例では、アクセストークンプロバイダを実装します。

#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

DeliveryDriverAPI インスタンスを作成する

GMTDDeliveryVehicleReporter インスタンスを取得するには、まず providerID、vehicleID、driverContext、accessTokenProvider を使用して GMTDDeliveryDriverAPI インスタンスを作成する必要があります。providerID は Google Cloud プロジェクト ID と同じです。また、ドライバ API から直接 GMTDDeliveryVehicleReporter インスタンスにアクセスできます。

次の例では、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];
}

必要に応じて VehicleReporter イベントをリッスンします。

GMTDDeliveryVehicleReporter は、locationTrackingEnabled が YES の場合に車両を定期的に更新します。こうした定期的な更新に応答するために、任意のオブジェクトは、GMTDVehicleReporterListener プロトコルに準拠して GMTDDeliveryVehicleReporter イベントをサブスクライブできます。

次のイベントを処理できます。

vehicleReporter:didSucceedVehicleUpdate

バックエンドサービスが車両の位置情報と状態の更新を正常に受信したことをドライバアプリに通知します。
vehicleReporter:didFailVehicleUpdate:withError

車両の更新に失敗したことをリスナーに通知します。位置情報の追跡が有効になっている限り、GMTDDeliveryVehicleReporter は引き続き最新のデータを Fleet Engine バックエンドに送信します。

次の例では、これらのイベントを処理します。

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

位置情報の記録を有効にする

位置情報の追跡を有効にするには、アプリで GMTDDeliveryVehicleReporter で locationTrackingEnabled を YES に設定します。そうすると、GMTDDeliveryVehicleReporter は最新の位置情報を自動的に送信します。GMSNavigator がナビゲーションモード（setDestinations で目的地が設定されている場合）で、locationTrackingEnabled が YES に設定されている場合、GMTDDeliveryVehicleReporter はルートと到着予定時刻の更新も自動的に送信します。

更新中に設定されたルートは、ドライバーがナビゲーションセッション中にナビゲートするルートと同じになります。したがって、配送追跡が正しく機能するには、-setDestinations:callback: で設定されたウェイポイントが Fleet Engine バックエンドで設定された配送先と一致している必要があります。

次の例では、位置情報の追跡を有効にしています。

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

デフォルトのレポート間隔は 10 秒ですが、locationUpdateInterval で変更できます。サポートされる最小更新間隔は 5 秒です。サポートされる最大更新間隔は 60 秒です。更新を頻繁に行うと、リクエストやエラーが遅くなる可能性があります。

位置情報の更新を無効にする

アプリで車両の位置情報の更新を無効にできます。たとえば、ドライバーのシフトが終了したときに、アプリで locationTrackingEnabled を NO に設定できます。

  _vehicleReporter.locationTrackingEnabled = NO

update_mask エラーを処理する

GMTDDeliveryVehicleReporter が車両のアップデートを送信すると、マスクが空の場合に update_mask エラーが発生することがあります。これは通常、起動後の最初のアップデートで発生します。次の例は、このエラーの処理方法を示しています。

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