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 Web Token を提供します。
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、無限大、負の値に設定すると、位置情報の自動更新が無効になります。トラッキング 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
更新によって返されたタスクの追跡情報構造。変更不可。