注文、乗車、その他のサービスについて、ユーザーがルートを追跡できるようにすることで、オンデマンドの乗車のエクスペリエンスをカスタマイズできます。
Consumer SDK とは
Consumer SDK は、オンデマンドの乗車向けの Fleet Engine の一部です。乗車データをモデル化し、Fleet Engine で乗車を追跡するインターフェースを提供します。また、地図ベースの豊富な表示を作成して、乗車をユーザーと共有するために使用するクラスを提供します。Consumer SDK をアプリに統合し、Fleet Engine 内で適切なロール プロファイルを設定して、このユーザー エクスペリエンスを作成します。
Consumer SDK のプラットフォーム固有の API を使用すると、乗車をネイティブに共有する機能をアプリケーションに組み込むことができます。Consumer SDK は、次のプラットフォームでご利用いただけます。
Consumer SDK を使用する理由
Consumer SDK をオンデマンドの乗車アプリケーションに統合すると、ほぼリアルタイムの位置情報の更新と道路にスナップされた位置情報により、包括的なユーザー エクスペリエンスを提供できます。ユーザーは、車両のルートを地図上に重ねて表示できます。また、乗車や配達の状況を把握するのに役立つ進捗状況の詳細も確認できます。
Consumer SDK でできること
Driver SDK と Fleet Engine の情報を使用して、次のような機能を備えたカスタマイズされたユーザー エクスペリエンスを作成できます。
ブランドのニーズに合わせて地図の UI をカスタマイズします。
車両がルートに沿って移動するにつれて、車両の現在地を追跡します。位置情報は定期的に更新されます。
迎車場所と降車場所の予定到着時刻（ETA）を表示します。
残りの距離を表示します。
ルート上のリアルタイム交通情報を表示します。
Consumer SDK の仕組み
Consumer SDK は、主に次のメカニズムに依存しています。
- 認証済みアプリがユーザーの注文に関連付けられた乗車を追跡できるように、適切な Fleet Engine ロールを設定します。
- バックエンド システムによって提供される、ユーザーと乗車の関連付け。
- 乗車データをモデル化し、ユーザー アプリで乗車セッションを共有する
TripModelSDK クラスとJourneySharingSessionSDK クラス。
Consumer SDK には、交通状況、地図マーカー、ETA、ルートデータなどの詳細情報を含む豊富なアプリ エクスペリエンスを作成できるように、他のインターフェースとクラスも用意されています。
次の表に、ユーザー アプリが追跡する乗車のフローを示します。
| 1 | ユーザー アプリが乗車をリクエストする | バックエンド サーバーがオンデマンドの乗車リクエストを受け取り、次の処理を行います。
|
| 2 | ドライバーが乗車を受け付ける | ドライバー アプリが乗車 ID と乗車情報を取得し、ドライバー が乗車を受け付けます。 |
| 3 | ユーザー アプリが乗車を追跡するためのアクセスをリクエストする | ユーザー アプリがバックエンドから乗車 ID を取得し、 乗車の追跡を開始するようリクエストします。 |
| 4 | ドライバーが乗車を開始する | ドライバーがドライバー アプリを使用して乗車を開始したことを示すと、アプリは Driver SDK を介してバックエンド サーバーに通知します。 たとえば、ドライバーが レストランを出発しようとしている場合や、迎車場所に向かっている場合などです。 |
| 5 | Fleet Engine が乗車情報の送信を開始する | Fleet Engine は乗車の追跡を開始し、その進捗状況をユーザー アプリと共有します。 |
| 6 | ユーザー アプリに乗車情報が表示される | ユーザー アプリはユーザーに通知し、 乗車情報の表示を開始します。乗車が進むにつれて、乗車情報が更新されます。 |
| 7 | トリップがキャンセルまたは完了する | ドライバーが乗車をキャンセルまたは完了すると、 ドライバー アプリは位置情報の追跡を無効にし、バックエンド サーバーは Fleet Engine に乗車をキャンセルまたは完了としてマークするよう指示します。 |
| 8 | ユーザー アプリが乗車の追跡を停止する | 乗車がキャンセルまたは完了として表示されます。 |
| 9 | 次のトリップに対してプロセスが繰り返される | 新しいトリップが作成され、プロセスが繰り返されます。 |
Consumer SDK の使用方法
プラットフォームを選択して、ユーザー アプリで乗車の追跡を開始する方法を確認してください。
Android
| 1 | Android で Consumer SDK をセットアップする | アプリでオンデマンドの乗車を追跡するには、Consumer SDK をセットアップします。詳細については、Android Consumer SDK を取得するをご覧ください。 |
| 2 | ビジュアル インターフェースをセットアップする | 地図を定義し、ベクター地図のサポートを追加して、ユーザー エクスペリエンスをセットアップします。詳細については、地図をセットアップするをご覧ください。 |
| 3 | トリップを追跡する | 乗車を追跡して、適切な車両の位置情報をユーザーと共有します。詳細については、乗車を追跡するをご覧ください。 |
| 5 | 乗車の進捗状況を更新し、乗車のエラーを処理する | 移動距離や到着予定時刻など、乗車の詳細情報を更新し、乗車中のエラーを処理します。詳細については、 乗車の進捗状況を更新するとおよび 乗車のエラーを処理するをご覧ください。 |
| 5 | トリップが完了したら、追跡を停止する | 乗車の追跡を停止して、車両の位置情報のユーザーとの共有を停止します。詳細については、乗車の追跡を停止するをご覧ください。 |
iOS
| 1 | iOS で Consumer SDK をセットアップする | アプリでオンデマンドの乗車を追跡するには、Consumer SDK をセットアップします。詳細については、iOS Consumer SDK を取得するをご覧ください。 |
| 2 | ビジュアル インターフェースをセットアップする | 地図ビューを初期化し、地図イベントを処理して、ユーザー エクスペリエンスをセットアップします。詳細については、地図をセットアップするをご覧ください。 |
| 3 | トリップを追跡する | 乗車を追跡して、適切な車両の位置情報をユーザーと共有します。詳細については、乗車を追跡するをご覧ください。 |
| 5 | 乗車の進捗状況を更新し、乗車のエラーを処理する | 移動距離や到着予定時刻など、乗車の詳細情報を更新し、乗車中のエラーを処理します。詳細については、 乗車の進捗状況を更新するとおよび 乗車のエラーを処理するをご覧ください。 |
| 5 | トリップが完了したら、追跡を停止する | 乗車の追跡を停止して、車両の位置情報のユーザーとの共有を停止します。詳細については、乗車の追跡を停止するをご覧ください。 |
JavaScript
| 1 | JavaScript で Consumer SDK をセットアップする | アプリでオンデマンドの乗車を追跡するには、Consumer SDK をセットアップします。詳細については、JavaScript Consumer SDK をセットアップするをご覧ください。 |
| 2 | 地図を読み込んでカスタマイズする | Maps JavaScript API を有効にして、認証を設定して、ユーザー エクスペリエンスをセットアップします。詳細については、地図をセットアップするをご覧ください。 |
| 3 | トリップを追跡する | 乗車を追跡して、適切な車両の位置情報をユーザーと共有します。詳細については、乗車を追跡するをご覧ください。 |
| 5 | 乗車の進捗状況を更新し、乗車のエラーを処理する | 移動距離や到着予定時刻など、乗車の詳細情報を更新し、乗車中のエラーを処理します。詳細については、 乗車の進捗状況を更新して追跡すると 乗車のエラーを処理するをご覧ください。 |
| 5 | トリップが完了したら、追跡を停止する | 乗車の追跡を停止して、車両の位置情報のユーザーとの共有を停止します。詳細については、乗車の追跡を停止するをご覧ください。 |
コンポーネント
このセクションでは、トリップを追跡するために必要な 2 つのコンポーネントについて要約します。
必要に応じて、次のコンポーネントを使用してユーザー エクスペリエンスをカスタマイズすることもできます。
認証トークン フェッチャー
Fleet Engine に保存されている位置情報データへのアクセスを制御するには、次の操作を行う必要があります。
サーバーに Fleet Engine 用の JSON ウェブトークン（JWT）作成サービスを実装します。詳細については、JWT を発行するをご覧ください。
ウェブアプリまたはモバイルアプリに認証トークン フェッチャーを実装して、位置情報データへのアクセスを認証します。トークン フェッチャーの設定の詳細については、 Android、iOS、またはJavaScript のセットアップ ガイドをご覧ください。
地図ビューと乗車トラッカー
乗車の追跡には、車両と地点の視覚化のためのコンポーネントと、ドライバーの ETA や走行距離の生のデータフィードが含まれます。
次の表に、これらのコンポーネントの説明を示します。
| コンポーネント | 説明 |
|---|---|
| ユーザーの地図ビュー | 地図ビューはトリップのライフサイクルを管理し、トリップが進むにつれて車両の位置の地点を表示します。車両のルートがわかっている場合、地図ビューは車両のルートのポリラインを更新して、ルートに沿った車両の進捗状況を示します。 |
| JavaScript の乗車位置情報プロバイダ | JavaScript ウェブアプリの場合、乗車位置情報プロバイダは、追跡対象オブジェクトの位置情報を共有乗車地図にフィードします。詳細については、
乗車位置情報プロバイダを
インスタンス化するをご覧ください。
乗車位置情報プロバイダを使用すると、乗車の次の詳細情報を追跡できます。
|
追跡対象の位置情報オブジェクト
位置情報プロバイダは、次の表に示す地点や車両などのオブジェクトの位置を追跡します。
| 追跡対象の位置情報 | 説明 |
|---|---|
| 迎車場所 | 迎車場所は、乗車が開始される場所です。 |
| 降車場所 | 降車場所は、トリップが終了する場所です。降車場所を示します。 |
| 地点 | 地点は、追跡対象の乗車のルート上の中間地点です。厳密に言えば、地点には迎車場所と降車場所を含めることができますが、通常、地点はルート上の中間地点を指します。たとえば、配達ルート上の迎車場所と降車場所の間にある停車地は地点です。詳細については、Fleet Engine ドキュメントの 乗車の地点 をご覧ください。 |
| 車両の位置 | 車両の位置は、報告された車両の位置です。詳細については、Fleet Engine ドキュメントの車両の位置をご覧ください。 |
地図のスタイルを設定する
マーカーとポリラインのスタイルによって、地図上の追跡対象の位置情報オブジェクトのルック＆フィールが決まります。カスタム スタイル オプションを使用して、ウェブ アプリケーションのスタイルに合わせることができます。
追跡対象の位置情報の表示を制御する
Fleet Engine の事前定義された位置情報プロバイダは、地図上の追跡対象の位置情報オブジェクトに対して次の表示ルールに従います。カスタムまたは派生した位置情報プロバイダを作成する場合は、表示ルールを変更できます。
車両は乗車中のみ表示されます: トリップ車両は、トリップに割り当てられた時点から降車時まで表示されます。トリップがキャンセルされた場合、車両は表示されなくなります。
その他の位置マーカーは常に表示されます: 起点、目的地、地点のその他の位置マーカーは常に地図上に表示されます。たとえば、乗車の降車場所や配送の配達場所は、乗車や配送の状態に関係なく、常に地図上に表示されます。
次のステップ
乗車を追跡するプラットフォームのドキュメントをご覧ください。