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。このフィールドを設定して、トラッキングを開始します。
継承: isPolling、 pollingIntervalMillis
refresh
refresh()
パラメータ: なし
戻り値:  void
追跡対象のビジネスを明示的に更新します。
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineShipmentLocationProviderOptions インターフェース

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

配送場所プロバイダのオプション。
authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマーのプロジェクト ID。
activePolylineCustomization optional
タイプ:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
アクティブなポリラインに適用されたカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、ShipmentPolylineCustomizationFunctionParams をご覧ください。
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、Infinity、または負の値に設定すると、位置情報の自動更新が無効になります。トラッキング ID パラメータ（配送業者の配送場所のトラッキング ID など）またはフィルタリング オプション（フリートの場所プロバイダのビューポート境界や属性フィルタなど）が変更されると、新しい位置情報の更新が 1 回取得されます。

デフォルトの最小ポーリング間隔は 5,000 ミリ秒です。ポーリング間隔を正の小さい値に設定すると、5000 が保存されて使用されます。
remainingPolylineCustomization optional
タイプ:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
残りのポリラインに適用されたカスタマイズ。残りのポリラインは、車両がまだ通過していないルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、ShipmentPolylineCustomizationFunctionParams をご覧ください。
takenPolylineCustomization optional
タイプ:  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
取得したポリラインに適用されたカスタマイズ。取得済みのポリラインは、車両がすでに通過したルートの一部に対応します。

このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、ShipmentPolylineCustomizationFunctionParams をご覧ください。
trackingId optional
タイプ:  string optional
位置情報プロバイダのインスタンス化直後に追跡するタスクのトラッキング ID。指定しない場合、位置情報プロバイダはタスクの追跡を開始しません。FleetEngineShipmentLocationProvider.trackingId を使用してトラッキング ID を設定し、トラッキングを開始します。

FleetEngineShipmentLocationProviderUpdateEvent インターフェース

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

FleetEngineShipmentLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
taskTrackingInfo optional
タイプ:  TaskTrackingInfo optional
更新によって返されるタスク追跡情報構造。変更不可。