Consumer SDK のオンデマンド ルートの概要

オンデマンドの移動について、消費者が注文、乗車、その他のサービスを追跡できるようにすることで、消費者のエクスペリエンスをカスタマイズします。

Consumer SDK とは

Consumer SDK は、オンデマンドの乗車用の Fleet Engine の一部です。このライブラリは、Fleet Engine でトリップデータをモデル化してトリップを追跡するインターフェースを提供します。また、地図ベースの豊富なディスプレイを作成して、消費者ユーザーと乗車情報を共有するために使用するクラスも提供します。このユーザー エクスペリエンスを作成するには、Consumer SDK をアプリに統合し、Fleet Engine 内で適切なロール プロファイルを設定します。

Consumer SDK のプラットフォーム固有の API を使用すると、アプリにネイティブにジャーニーを共有する機能を組み込むことができます。Consumer SDK は、次のプラットフォームでご利用いただけます。

• Android
• iOS
• JavaScript

Consumer SDK を使用する理由

オンデマンドの乗車アプリに Consumer SDK を統合すると、ほぼリアルタイムの位置情報の更新と道路上の正確な位置情報により、包括的なユーザー エクスペリエンスを提供できます。地図上に車両のルートが重ねて表示され、進行状況の詳細も表示されるため、乗車や配達の状況を把握できます。

Consumer SDK でできること

Driver SDK と Fleet Engine の情報を使用して、次のような機能を備えたカスタマイズされたユーザー エクスペリエンスを作成できます。

• 地図の UI をカスタマイズして、ブランディングのニーズに合わせます。

• ルートに沿って移動する車両の現在地を追跡し、位置情報を定期的に更新します。

• 乗車場所と降車場所の到着予定時刻（ETA）を表示します。

• 残りの距離を表示します。

• ルート上のリアルタイムの交通状況を表示します。

Consumer SDK の仕組み

大まかに言うと、Consumer SDK は次のメカニズムに依存しています。

• 認証済みアプリが消費者の注文に関連付けられた乗車を追跡できるように、適切な Fleet Engine ロールを付与する。
• バックエンド システムによって提供される、利用者と乗車との関連付け。
• ルートデータをモデル化し、コンシューマー アプリでルート セッションを共有する TripModel と JourneySharingSession の SDK クラス。

Consumer SDK には、交通状況、地図マーカー、到着予定時刻、ルートデータなどの詳細情報を含むリッチなアプリ エクスペリエンスを作成できるように、他のインターフェースやクラスも用意されています。

この表は、ユーザー向けアプリで追跡される乗車ルートのフローを示しています。

1	消費者向けアプリが乗車をリクエストする	バックエンド サーバーはオンデマンドの乗車リクエストを取得し、次の処理を行います。 Fleet Engine で乗車を作成します。 ルートを車両に割り当てます。
2	ドライバーが乗車を承認する	ドライバー アプリは乗車 ID と乗車情報を取得し、ドライバーは乗車を承諾します。
3	乗客用アプリが乗車状況の追跡へのアクセスをリクエストする	コンシューマー アプリは、バックエンドから乗車 ID を取得し、乗車の追跡開始をリクエストします。
4	乗車を開始する	乗車が開始されたことをドライバーがドライバー アプリで示すと、アプリは Driver SDK を介してバックエンド サーバーに通知します。たとえば、ドライバーがレストランを出発しようとしているときや、乗車場所に移動しているときなどです。
5	Fleet Engine が乗車情報を送信し始める	Fleet Engine は、乗車を追跡し、その進行状況をユーザーアプリと共有します。
6	消費者向けアプリに旅行情報が表示される	消費者向けアプリは消費者に通知し、ルート情報を表示し始めます。ルートの進行に合わせてルート情報が更新されます。
7	ルートがキャンセルされたか完了した	乗車をキャンセルまたは完了すると、ドライバー アプリは位置情報の追跡を無効にし、バックエンド サーバーは Fleet Engine に乗車をキャンセルまたは完了としてマークするよう指示します。
8	消費者向けアプリが乗車ルートの追跡を停止する	乗車がキャンセルまたは完了として表示されます。
9	次の乗車でも同じプロセスが繰り返されます	新しい旅行が作成され、プロセスが繰り返されます。

Consumer SDK の使用方法

プラットフォームを選択して、コンシューマー アプリで乗車を追跡する方法をご確認ください。

コンポーネント

このセクションでは、乗車を追跡するために必要な 2 つのコンポーネントの概要を説明します。

• 認証トークン フェッチャー。
• 地図表示と移動状況トラッカー。

必要に応じて、次のコンポーネントを使用してユーザー エクスペリエンスをカスタマイズすることもできます。

• 地図のスタイルを設定する。
• 追跡された位置情報の公開設定を制御します。

認証トークン フェッチャー

Fleet Engine に保存されている位置情報へのアクセスを制御するには、次の操作を行う必要があります。

1. サーバーで Fleet Engine の JSON ウェブトークン（JWT）作成サービスを実装します。詳細については、JWT を発行するをご覧ください。

2. ウェブアプリまたはモバイルアプリに認証トークン フェッチャーを実装して、位置情報へのアクセスを認証します。トークン フェッチャーの設定について詳しくは、Android、iOS、JavaScript のセットアップ ガイドをご覧ください。

地図表示と乗車トラッカー

乗車追跡には、車両と経由地の可視化コンポーネントと、ドライバーの到着予定時刻や残りの走行距離の生データフィードが含まれます。

次の表に、これらのコンポーネントを示します。

コンポーネント	説明
ユーザーの地図ビュー	地図ビューは、ルートのライフサイクルを管理し、ルートの進行に合わせて車両の位置の経由地を表示します。車両のルートがわかっている場合、地図ビューは車両のルートのポリラインを更新して、ルートに沿った車両の進行状況を示します。
JavaScript の乗車場所プロバイダ	JavaScript ウェブアプリの場合、ルートの現在地プロバイダは、追跡対象オブジェクトの現在地情報を共有ルート地図にフィードします。詳しくは、乗車位置プロバイダをインスタンス化するをご覧ください。乗車位置情報プロバイダを使用すると、乗車に関する次の詳細情報をトラッキングできます。 旅行の乗車場所または降車場所。 乗車に割り当てられた車両の位置とルート。

追跡された位置情報オブジェクト

位置情報プロバイダは、次の表に示すように、経由地や車両などのオブジェクトの位置を追跡します。

追跡された位置情報	説明
受け取り場所	乗車場所は、乗車が開始される場所です。
宛先のロケーション	目的地は、旅行の終了地点です。降車場所をマークします。
ウェイポイントの場所	ウェイポイントの場所は、追跡された旅行のルート上の任意の場所です。技術的には、経由地には乗車場所と降車場所を含めることができますが、通常、経由地はルート上の途中停車地を指します。たとえば、配送ルートの集荷場所と配送先の間の停車地は経由地です。詳細については、Fleet Engine ドキュメントの乗車地点をご覧ください。
車両の販売店	車両の位置情報は、報告された車両の位置情報です。詳細については、Fleet Engine のドキュメントの車両の位置情報をご覧ください。

地図のスタイルを設定する

マーカーとポリラインのスタイルは、地図上の追跡対象の位置オブジェクトの外観を決定します。カスタム スタイル オプションを使用すると、ウェブ アプリケーションのスタイルに合わせることができます。

チェック中の場所の公開設定を管理する

Fleet Engine の事前定義された位置情報プロバイダは、地図上の追跡対象の位置情報オブジェクトに対して次の可視性ルールに従います。カスタムまたは派生位置情報プロバイダを作成する場合は、可視性ルールを変更できます。

• 車両は乗車中のみ表示される: 乗車車両は、乗車に割り当てられた時点から降車時点まで表示されます。乗車がキャンセルされると、車両は表示されなくなります。

• その他の位置マーカーは常に表示される: 起点、目的地、経由地のその他の位置マーカーは常に地図上に表示されます。たとえば、乗車場所や配送先は、乗車や配送のステータスに関係なく、常に地図上に表示されます。

次のステップ

旅行を追跡するプラットフォームのドキュメントをご覧ください。

• Android
• iOS
• JavaScript