Shipment Tracking

FleetEngineShipmentLocationProvider クラス

google.maps.journeySharing.FleetEngineShipmentLocationProvider クラス

発送元プロバイダ。

このクラスは PollingLocationProvider を拡張します。

アクセスするには、const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出します。詳しくは、Maps JavaScript API のライブラリをご覧ください。

FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
パラメータ: 
Fleet Engine の配送追跡用に新しい位置情報プロバイダを作成します。
trackingId
タイプ:  string
位置情報プロバイダが監視するタスクのトラッキング ID。この項目を設定してトラッキングを開始します。
継承される: isPollingpollingIntervalMillis
refresh
refresh()
パラメータ: なし
戻り値:  void
記録された場所を明示的に更新します。
継承される: addListener
error
function(event)
引数: 
ロケーションのプロバイダでエラーが発生した場合にトリガーされるイベント。
update
function(event)
フリート エンジンのデータ更新リクエストが完了したときにトリガーされるイベント。
継承される: ispollingchange

FleetEngineShipmentLocationProviderOptions インターフェース

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions インターフェース

配送場所プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
フリート エンジンにクライアントを認証するための JSON Web Token を提供します。
projectId
タイプ:  string
Google Cloud Console にあるコンシューマのプロジェクト ID。
deliveryVehicleMarkerCustomization optional
タイプ:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
配送車両マーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトを指定すると、マーカーに作成された変更内容は、マーカーが作成されるとマーカーに適用されます。存在する場合は、デフォルトのオプションが上書きされます。
  • 関数を指定すると、マーカーが作成されると 1 回呼び出され、その後地図表示に追加されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されています)。この関数は、このマーカーに対応するデータが変更されているかどうかに関係なく、ロケーション プロバイダが Fleet Engine からデータを受信すると呼び出されます。

    指定されたパラメータとその使用方法については、ShipmentMarkerCustomizationFunctionParams をご覧ください。
destinationMarkerCustomization optional
タイプ:  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
カスタマイズをデスティネーション マーカーに適用しました。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトを指定すると、マーカーに作成された変更内容は、マーカーが作成されるとマーカーに適用されます。存在する場合は、デフォルトのオプションが上書きされます。
  • 関数を指定すると、マーカーが作成されると 1 回呼び出され、その後地図表示に追加されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されています)。この関数は、このマーカーに対応するデータが変更されているかどうかに関係なく、ロケーション プロバイダが Fleet Engine からデータを受信すると呼び出されます。

    指定されたパラメータとその使用方法については、ShipmentMarkerCustomizationFunctionParams をご覧ください。
pollingIntervalMillis optional
タイプ:  number optional
位置情報の更新を取得する間隔の最小値(ミリ秒単位)。位置情報の更新データの取得に pollingIntervalMillis 時間以上かかる場合、次の位置情報の更新は、現在の更新が完了するまで開始されません。

この値を 0、無限、負の値に設定すると、位置情報の自動更新が無効になります。トラッキング ID パラメータ(配送場所プロバイダの配送 ID など)またはフィルタ オプション(配送場所プロバイダのビューポート境界または属性フィルタなど)が変更された場合、新しい位置情報の更新が 1 回取得されます。

デフォルトのポーリング間隔は 5,000 ミリ秒です。ポーリング間隔を低い正の値に設定すると、5000 が保存され、使用されます。
trackingId optional
タイプ:  string optional
位置情報プロバイダをインスタンス化した直後にトラッキングするタスクのトラッキング ID。指定しない場合、位置情報プロバイダはタスクのトラッキングを開始しません。FleetEngineShipmentLocationProvider.trackingId を使用してトラッキング ID を設定し、トラッキングを開始します。

FleetEngineShipmentLocationProviderUpdateEvent インターフェース

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent インターフェース

FleetEngineShipmentLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。

taskTrackingInfo optional
タイプ:  TaskTrackingInfo optional
更新によって返されるタスク追跡情報構造。変更不可。