JavaScript Consumer SDK クイック リファレンス

JavaScript Consumer SDK を使用すると、ウェブベースのユーザーアプリで、Fleet Engine で追跡されている車両の位置やその他の関心対象地域を地図上に表示できるため、ユーザーはオンデマンドのルートや予定されている配送の進捗状況を把握できます。Maps JavaScript API の journeySharing ライブラリとして読み込まれます。

JavaScript Consumer SDK: 主な特徴

  • プロダクト: JavaScript Consumer SDK
  • 別名: JavaScript 用 Consumer SDK、Mobility Services オンデマンド乗車 JavaScript、JavaScript SDK
  • カテゴリ: ルート
  • プラットフォーム: JavaScript(ブラウザ)
  • 実行場所: クライアント(アプリまたはブラウザのコード)
  • リリース ステージ: GA
  • ライフサイクル: アクティブ
  • 概要: JavaScript Consumer SDK の概要

JavaScript Consumer SDK: 使用する場面

JavaScript Consumer SDK を使用するケース:

  • Fleet Engine が追跡するオンデマンド トリップの車両の現在地とルートを、ウェブページまたはウェブアプリでユーザーに表示する必要があります。
  • Fleet Engine で追跡されている、予定された配送の集荷または配達の進捗状況を、消費者がブラウザで追跡できるようにする必要があります。
  • ウェブベースの地図ビューで、ルートの到着予定時刻、残りの距離、リアルタイムの交通状況を表示する必要があります。
  • ウェブの消費者向けトラッキング ビューで、ルートマーカー、ルート ポリライン、地図のスタイルをカスタマイズする必要がある。

次の場合、JavaScript Consumer SDK を使用しないでください。

  • ネイティブ Android アプリ内で、ユーザーがルートを追跡できるようにする必要があります。代わりに Consumer SDK for Android を使用してください。
  • ネイティブ iOS アプリ内でルート追跡のユーザー エクスペリエンスが必要な場合は、代わりに Consumer SDK for iOS を使用してください。
  • ドライバーの Android アプリから Fleet Engine に、ドライバーの位置情報とルートの進行状況を報告する必要があります。代わりに Driver SDK for Android を使用してください。
  • ドライバーの iOS アプリから Fleet Engine に、ドライバーの位置情報とルートの進行状況を報告する必要があります。代わりに Driver SDK for iOS を使用してください。
  • Fleet Engine のルートやタスクを追跡しない一般的なウェブ地図が必要な場合。代わりに Maps JavaScript API を使用してください。

JavaScript Consumer SDK: 設定

JavaScript Consumer SDK: よくある間違い

  • 問題: JourneySharingMapView 地図に初期ビューポート(中心とズーム)を指定しないと、地図の 'ready' イベントが呼び出されないことがあります。修正方法: マップビューを作成した後に mapView.map.setCenter(...) と mapView.map.setZoom(...) を呼び出します。/maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey をご覧ください。
  • 問題: 非同期のルート情報リクエストでエラーがスローされません。これらは、位置情報プロバイダで 'error' イベントとしてのみ到着するため、リスナーを追加しない限り、気づかれません。修正: locationProvider.addListener('error', ...) を追加し、ライブラリ呼び出しを try...catch ブロックでラップします。/maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey をご覧ください。
  • 問題: journeySharing ライブラリを読み込まないと、google.maps.journeySharing クラスを使用できません。修正方法: Maps JavaScript API スクリプトの URL に libraries=journeySharing を追加するか、await google.maps.importLibrary("journeySharing") を使用してクラスを読み込みます。/maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey をご覧ください。
  • 問題: ブラウザ(信頼性の低い環境)からの Fleet Engine 呼び出しには、バックエンド サーバーが発行する JWT が必要です。API キーだけでは、ルートデータへのアクセスは認可されません。修正: バックエンドから JWT を発行し、トークンと expiresInSeconds を返す authTokenFetcher を指定します。/maps/documentation/mobility/journey-sharing/on-demand/javascript/setup をご覧ください。

JavaScript Consumer SDK: 以前の機能と非推奨の機能

  • JourneySharingMapView と JourneySharingMapViewOptions のマーカーとポリラインの設定オプション(vehicleMarkerSetup、originMarkerSetup、destinationMarkerSetup、waypointMarkerSetup、anticipatedRoutePolylineSetup、takenRoutePolylineSetup など): 非推奨。 代替: 位置情報プロバイダ(vehicleMarkerCustomization など)の MarkerCustomizationFunction オプションと PolylineCustomizationFunction オプション。症状: 今後のリリースで削除される予定です。移行ガイドをご覧ください。
  • JourneySharingMapView.locationProvider と JourneySharingMapViewOptions.locationProvider: 非推奨。置換: JourneySharingMapView.locationProviders と JourneySharingMapViewOptions.locationProviders。
  • JourneySharingMapView マーカーとポリライン リストのプロパティ(vehicleMarkers、originMarkers、destinationMarkers、waypointMarkers、anticipatedRoutePolylines、takenRoutePolylines、タスク マーカーのプロパティ): 非推奨。 代替: 位置情報プロバイダの MarkerCustomizationFunction コールバックと PolylineCustomizationFunction コールバック。移行ガイドをご覧ください。

JavaScript Consumer SDK でできること

各タスクについては、以下のリンク先のガイドをご覧ください。また、機能エクスプローラでプロダクトを比較することもできます。