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

注文、配車、その他のサービスについて、ユーザーがトリップを追跡できるようにすることで、オンデマンドのトリップのユーザー エクスペリエンスをカスタマイズします。

旅行を追跡する消費者向けアプリ

Consumer SDK とは

Consumer SDK は、オンデマンドの乗車用の Fleet Engine の一部です。この SDK は、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 ロールを付与します。
  • バックエンド システムから提供される、利用者と乗車との関連付け。
  • 乗車データをモデル化し、コンシューマー アプリで乗車セッションを共有する TripModel と JourneySharingSession の SDK クラス。

Consumer 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 の使用方法

プラットフォームを選択して、ユーザー向けアプリで乗車を追跡する方法をご確認ください。

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 に保存されている位置情報データへのアクセスを制御するには、次の操作を行う必要があります。

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

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

地図ビューとルートトラッカー

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

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

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

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

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

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

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

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

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

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

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

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

次のステップ

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