ルートを追跡すると、適切な車両の位置情報がコンシューマ アプリに表示されます。これを行うには、アプリでルートの追跡を開始し、ルートの進行状況を更新し、ルートの完了時にルートの追跡を停止する必要があります。
このドキュメントでは、そのプロセスについて説明します。
ルートのフォローを開始する
旅のフォローを開始する手順は次のとおりです。
降車場所や乗車場所などのすべてのユーザー入力を
ViewControllerから収集します。ルートの直接フォローを開始するには、新しい
ViewControllerを作成してください。
次の例は、ビューが読み込まれた直後にルートの追跡を開始する方法を示しています。
Swift
/*
* MapViewController.swift
*/
override func viewDidLoad() {
super.viewDidLoad()
...
self.mapView = GMTCMapView(frame: UIScreen.main.bounds)
self.mapView.delegate = self
self.view.addSubview(self.mapView)
}
func mapViewDidInitializeCustomerState(_: GMTCMapView) {
self.mapView.pickupLocation = self.selectedPickupLocation
self.mapView.dropoffLocation = self.selectedDropoffLocation
self.startConsumerMatchWithLocations(
pickupLocation: self.mapView.pickupLocation!,
dropoffLocation: self.mapView.dropoffLocation!
) { [weak self] (tripName, error) in
guard let strongSelf = self else { return }
if error != nil {
// print error message.
return
}
let tripService = GMTCServices.shared().tripService
// Create a tripModel instance for listening the update of the trip
// specified by this trip name.
let tripModel = tripService.tripModel(forTripName: tripName)
// Create a journeySharingSession instance based on the tripModel
let journeySharingSession = GMTCJourneySharingSession(tripModel: tripModel)
// Add the journeySharingSession instance on the mapView for UI updating.
strongSelf.mapView.show(journeySharingSession)
// Register for the trip update events.
tripModel.register(strongSelf)
strongSelf.currentTripModel = tripModel
strongSelf.currentJourneySharingSession = journeySharingSession
strongSelf.hideLoadingView()
}
self.showLoadingView()
}
Objective-C
/*
* MapViewController.m
*/
- (void)viewDidLoad {
[super viewDidLoad];
...
self.mapView = [[GMTCMapView alloc] initWithFrame:CGRectZero];
self.mapView.delegate = self;
[self.view addSubview:self.mapView];
}
// Handle the callback when the GMTCMapView did initialized.
- (void)mapViewDidInitializeCustomerState:(GMTCMapView *)mapview {
self.mapView.pickupLocation = self.selectedPickupLocation;
self.mapView.dropoffLocation = self.selectedDropoffLocation;
__weak __typeof(self) weakSelf = self;
[self startTripBookingWithPickupLocation:self.selectedPickupLocation
dropoffLocation:self.selectedDropoffLocation
completion:^(NSString *tripName, NSError *error) {
__typeof(self) strongSelf = weakSelf;
GMTCTripService *tripService = [GMTCServices sharedServices].tripService;
// Create a tripModel instance for listening to updates to the trip specified by this trip name.
GMTCTripModel *tripModel = [tripService tripModelForTripName:tripName];
// Create a journeySharingSession instance based on the tripModel.
GMTCJourneySharingSession *journeySharingSession =
[[GMTCJourneySharingSession alloc] initWithTripModel:tripModel];
// Add the journeySharingSession instance on the mapView for updating the UI.
[strongSelf.mapView showMapViewSession:journeySharingSession];
// Register for trip update events.
[tripModel registerSubscriber:self];
strongSelf.currentTripModel = tripModel;
strongSelf.currentJourneySharingSession = journeySharingSession;
[strongSelf hideLoadingView];
}];
[self showLoadingView];
}
旅行のフォローを停止する
ルートのフォローは完了するかキャンセルされると停止します。次の例は、アクティブなルートの共有を停止する方法を示しています。
Swift
/*
* MapViewController.swift
*/
func cancelCurrentActiveTrip() {
// Stop the tripModel
self.currentTripModel.unregisterSubscriber(self)
// Remove the journey sharing session from the mapView's UI stack.
self.mapView.hide(journeySharingSession)
}
Objective-C
/*
* MapViewController.m
*/
- (void)cancelCurrentActiveTrip {
// Stop the tripModel
[self.currentTripModel unregisterSubscriber:self];
// Remove the journey sharing session from the mapView's UI stack.
[self.mapView hideMapViewSession:journeySharingSession];
}
移動状況を更新
ルート中のルートの進行状況は、次のように管理します。
更新の受信を開始します。例については、更新のリッスンを開始する例をご覧ください。
ルートの更新に対応する。例については、ルート更新情報の処理例をご覧ください。
ルートが完了した場合やルートがキャンセルされた場合は、最新情報のリッスンを停止します。例については、更新のリッスンを停止する例をご覧ください。
更新のリッスンを開始する例
次の例は、tripModel コールバックを登録する方法を示しています。
Swift
/*
* MapViewController.swift
*/
override func viewDidLoad() {
super.viewDidLoad()
// Register for trip update events.
self.currentTripModel.register(self)
}
Objective-C
/*
* MapViewController.m
*/
- (void)viewDidLoad {
[super viewDidLoad];
// Register for trip update events.
[self.currentTripModel registerSubscriber:self];
...
}
更新情報のリッスンを停止する例
次の例は、tripModel コールバックの登録をキャンセルする方法を示しています。
Swift
/*
* MapViewController.swift
*/
deinit {
self.currentTripModel.unregisterSubscriber(self)
}
Objective-C
/*
* MapViewController.m
*/
- (void)dealloc {
[self.currentTripModel unregisterSubscriber:self];
...
}
ルート更新情報を処理する例
次の例は、GMTCTripModelSubscriber プロトコルを実装して、ルート状態が更新された場合にコールバックを処理する方法を示しています。
Swift
/*
* MapViewController.swift
*/
func tripModel(_: GMTCTripModel, didUpdate trip: GMTSTrip?, updatedPropertyFields: GMTSTripPropertyFields) {
// Update the UI with the new `trip` data.
self.updateUI(with: trip)
}
func tripModel(_: GMTCTripModel, didUpdate tripStatus: GMTSTripStatus) {
// Handle trip status did change.
}
func tripModel(_: GMTCTripModel, didUpdateActiveRouteRemainingDistance activeRouteRemainingDistance: Int32) {
// Handle remaining distance of active route did update.
}
func tripModel(_: GMTCTripModel, didUpdateActiveRoute activeRoute: [GMTSLatLng]?) {
// Handle trip active route did update.
}
func tripModel(_: GMTCTripModel, didUpdate vehicleLocation: GMTSVehicleLocation?) {
// Handle vehicle location did update.
}
func tripModel(_: GMTCTripModel, didUpdatePickupLocation pickupLocation: GMTSTerminalLocation?) {
// Handle pickup location did update.
}
func tripModel(_: GMTCTripModel, didUpdateDropoffLocation dropoffLocation: GMTSTerminalLocation?) {
// Handle drop off location did update.
}
func tripModel(_: GMTCTripModel, didUpdatePickupETA pickupETA: TimeInterval) {
// Handle the pickup ETA did update.
}
func tripModel(_: GMTCTripModel, didUpdateDropoffETA dropoffETA: TimeInterval) {
// Handle the drop off ETA did update.
}
func tripModel(_: GMTCTripModel, didUpdateRemaining remainingWaypoints: [GMTSTripWaypoint]?) {
// Handle updates to the pickup, dropoff or intermediate destinations of the trip.
}
func tripModel(_: GMTCTripModel, didFailUpdateTripWithError error: Error?) {
// Handle the error.
}
func tripModel(_: GMTCTripModel, didUpdateIntermediateDestinations intermediateDestinations: [GMTSTerminalLocation]?) {
// Handle the intermediate destinations being updated.
}
func tripModel(_: GMTCTripModel, didUpdateActiveRouteTraffic activeRouteTraffic: GMTSTrafficData?) {
// Handle trip active route traffic being updated.
}
Objective-C
/*
* MapViewController.m
*/
#pragma mark - GMTCTripModelSubscriber implementation
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateTrip:(nullable GMTSTrip *)trip
updatedPropertyFields:(enum GMTSTripPropertyFields)updatedPropertyFields {
// Update the UI with the new `trip` data.
[self updateUIWithTrip:trip];
...
}
- (void)tripModel:(GMTCTripModel *)tripModel didUpdateTripStatus:(enum GMTSTripStatus)tripStatus {
// Handle trip status did change.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateActiveRouteRemainingDistance:(int32_t)activeRouteRemainingDistance {
// Handle remaining distance of active route did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateActiveRoute:(nullable NSArray<GMTSLatLng *> *)activeRoute {
// Handle trip active route did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateVehicleLocation:(nullable GMTSVehicleLocation *)vehicleLocation {
// Handle vehicle location did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdatePickupLocation:(nullable GMTSTerminalLocation *)pickupLocation {
// Handle pickup location did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateDropoffLocation:(nullable GMTSTerminalLocation *)dropoffLocation {
// Handle drop off location did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel didUpdatePickupETA:(NSTimeInterval)pickupETA {
// Handle the pickup ETA did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateRemainingWaypoints:(nullable NSArray<GMTSTripWaypoint *> *)remainingWaypoints {
// Handle updates to the pickup, dropoff or intermediate destinations of the trip.
}
- (void)tripModel:(GMTCTripModel *)tripModel didUpdateDropoffETA:(NSTimeInterval)dropoffETA {
// Handle the drop off ETA did update.
}
- (void)tripModel:(GMTCTripModel *)tripModel didFailUpdateTripWithError:(nullable NSError *)error {
// Handle the error.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateIntermediateDestinations:
(nullable NSArray<GMTSTerminalLocation *> *)intermediateDestinations {
// Handle the intermediate destinations being updated.
}
- (void)tripModel:(GMTCTripModel *)tripModel
didUpdateActiveRouteTraffic:(nullable GMTSTrafficData *)activeRouteTraffic {
// Handle trip active route traffic being updated.
}
ルートエラーを処理する
tripModel をサブスクライブしてエラーが発生した場合は、デリゲート メソッド tripModel(_:didFailUpdateTripWithError:) を実装することで、tripModel のコールバックを取得できます。エラー メッセージは Google Cloud のエラー標準に従います。詳細なエラー メッセージの定義とすべてのエラーコードについては、Google Cloud エラーのドキュメントをご覧ください。
ルートのモニタリング中に発生する可能性のある一般的なエラーは次のとおりです。
| HTTP | RPC | 説明 |
|---|---|---|
| 400 | INVALID_ARGUMENT | クライアントが無効なルート名を指定しました。ルート名は providers/{provider_id}/trips/{trip_id} の形式にする必要があります。provider_id は、サービス プロバイダが所有する Cloud プロジェクトの ID にする必要があります。 |
| 401 | UNAUTHENTICATED | このエラーは、有効な認証情報がない場合に発生します。たとえば、JWT トークンがルート ID なしで署名されている場合や、JWT トークンが期限切れの場合などです。 |
| 403 | PERMISSION_DENIED | このエラーは、クライアントに十分な権限がない場合（コンシューマ ロールを持つユーザーが updateTrip を呼び出そうとした場合など）、JWT トークンが無効な場合、またはクライアント プロジェクトで API が有効になっていない場合に表示されます。JWT トークンがないか、リクエストされたルート ID と一致しないルート ID でトークンが署名されている可能性があります。 |
| 429 | RESOURCE_EXHAUSTED | リソースの割り当てがゼロであるか、トラフィックのレートが上限を超えています。 |
| 503 | UNAVAILABLE | サービス利用不可。通常、サーバーがダウンしています。 |
| 504 | DEADLINE_EXCEEDED | リクエスト期限を超えました。このエラーは、呼び出し元がメソッドのデフォルトの期限よりも短い期限を設定し（つまり、リクエストされた期限ではサーバーがリクエストを処理できない）、リクエストが期限内に完了しなかった場合に発生します。 |
コンシューマ SDK エラーの処理
Consumer SDK がコールバック メカニズムを使用して、ルートの更新エラーをユーザーアプリに送信します。コールバック パラメータは、プラットフォーム固有の戻り値の型です（Android では TripUpdateError、iOS では NSError）。
ステータス コードを抽出する
コールバックに渡されるエラーは通常 gRPC エラーであり、ステータス コードの形式で追加情報を抽出することもできます。ステータス コードの完全なリストについては、gRPC でのステータス コードとその使用をご覧ください。
Swift
NSError は tripModel(_:didFailUpdateTripWithError:) でコールバックされます。
// Called when there is a trip update error.
func tripModel(_ tripModel: GMTCTripModel, didFailUpdateTripWithError error: Error?) {
// Check to see if the error comes from gRPC.
if let error = error as NSError?, error.domain == "io.grpc" {
let gRPCErrorCode = error.code
...
}
}
Objective-C
NSError は tripModel:didFailUpdateTripWithError: でコールバックされます。
// Called when there is a trip update error.
- (void)tripModel:(GMTCTripModel *)tripModel didFailUpdateTripWithError:(NSError *)error {
// Check to see if the error comes from gRPC.
if ([error.domain isEqualToString:@"io.grpc"]) {
NSInteger gRPCErrorCode = error.code;
...
}
}
ステータス コードの解釈
ステータス コードは、サーバーおよびネットワーク関連のエラーとクライアントサイドのエラーの 2 種類のエラーに対応します。
サーバーおよびネットワークのエラー
次のステータス コードはネットワーク エラーまたはサーバー エラーであり、解決するための対応は必要ありません。Consumer SDK は自動的に復元します。
| ステータス コード | 説明 |
|---|---|
| ABORTED | サーバーがレスポンスの送信を停止しました。通常、この問題はサーバーの問題が原因で発生します。 |
| CANCELLED | サーバーが送信レスポンスを終了しました。これは通常、 アプリがバックグラウンドに送信されたとき、または コンシューマ アプリの状態が変更されたときに発生します。 |
| INTERRUPTED | |
| DEADLINE_EXCEEDED | サーバーの応答に時間がかかりすぎました。 |
| UNAVAILABLE | サーバーが利用できなかった。これは通常、ネットワークの問題が原因です。 |
クライアントエラー
次のステータス コードはクライアント エラーを示します。解決には対処する必要があります。Consumer SDK は経路の共有を終了するまでルートの更新の再試行を続けますが、ユーザーが対応しない限り復元はされません。
| ステータス コード | 説明 |
|---|---|
| INVALID_ARGUMENT | ユーザー アプリで指定したルート名が無効です。ルート名は providers/{provider_id}/trips/{trip_id} の形式で指定してください。
|
| NOT_FOUND | 旅行が作成されなかった。 |
| PERMISSION_DENIED | コンシューマ アプリに十分な権限がありません。このエラーは、次の場合に発生します。
|
| RESOURCE_EXHAUSTED | リソース割り当てがゼロであるか、トラフィック フローのレートが制限速度を超えている。 |
| UNAUTHENTICATED | JWT トークンが無効なため、リクエストが認証に失敗しました。このエラーは、JWT トークンがルート ID なしで署名されている場合、または JWT トークンの有効期限が切れている場合に発生します。 |