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 の事前定義された位置情報プロバイダは、地図上の追跡対象の位置情報オブジェクトに対して、次の公開設定ルールに従います。カスタムまたは派生の位置情報プロバイダを作成する場合は、公開ルールを変更できます。

  • 車両は、トリップが進行中の場合にのみ表示されます。トリップ車両は、トリップに割り当てられてから降車するまで表示されます。トリップがキャンセルされると、車両は表示されなくなります。

  • 他のすべての位置マーカーは常に表示される: 出発地、目的地、ウェイポイントの他のすべての位置マーカーは、常に地図上に表示されます。たとえば、トリップの降車場所や荷物の配送場所は、トリップや配送のステータスに関係なく、常にマップ上に表示されます。

次のステップ

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