Shipment Tracking

FleetEngineShipmentLocationProvider クラス

google.maps.journeySharing.FleetEngineShipmentLocationProvider class
extends PollingLocationProvider
library "journeySharing"

出荷場所のプロバイダ。

const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing");

コンストラクタ
FleetEngineShipmentLocationProvider	FleetEngineShipmentLocationProvider(options) パラメータ: options: FleetEngineShipmentLocationProviderOptions 位置情報プロバイダのオプション。 Fleet Engine の荷物追跡用の新しい位置情報プロバイダを作成します。

プロパティ
trackingId	タイプ: string この位置情報プロバイダが監視するタスクのトラッキング ID。トラッキングを開始するには、このフィールドを設定します。
継承元: isPolling、 pollingIntervalMillis

メソッド
refresh	refresh() パラメータ: なし 戻り値: void 追跡対象の位置情報を明示的に更新します。
継承: addListener

イベント
error	function(event) 引数: event: ErrorEvent 位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update	function(event) 引数: event: FleetEngineShipmentLocationProviderUpdateEvent Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineShipmentLocationProviderOptions インターフェース

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

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

プロパティ
authTokenFetcher	タイプ: AuthTokenFetcher クライアントを Fleet Engine に対して認証するための JSON ウェブトークンを提供します。
projectId	タイプ: string Google Cloud コンソールから取得したコンシューマのプロジェクト ID。
activePolylineCustomization 省略可	タイプ: (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional アクティブなポリラインに適用されるカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。 このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。 PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。 関数が指定されている場合、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、または位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。このポリラインに対応するデータが変更されたかどうかは関係ありません。 指定されたパラメータとその用途のリストについては、ShipmentPolylineCustomizationFunctionParams をご覧ください。
deliveryVehicleMarkerCustomization 省略可	タイプ: (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional 配送車両マーカーに適用されるカスタマイズ。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティブ機能（クリック処理など）を指定します。 MarkerOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、マーカーの作成後にマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。 関数が指定されている場合、マーカーが作成されるときに 1 回呼び出され、その後、マップビューに追加されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。 指定されたパラメータとその用途の一覧については、ShipmentMarkerCustomizationFunctionParams をご覧ください。
destinationMarkerCustomization 省略可	タイプ: (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional 目的地のマーカーに適用されるカスタマイズ。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティブ機能（クリック処理など）を指定します。 MarkerOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、マーカーの作成後にマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。 関数が指定されている場合、マーカーが作成されるときに 1 回呼び出され、その後、マップビューに追加されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、このマーカーに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。 指定されたパラメータとその用途の一覧については、ShipmentMarkerCustomizationFunctionParams をご覧ください。
pollingIntervalMillis 省略可	タイプ: number optional 位置情報の更新を取得する最小間隔（ミリ秒）。位置情報の更新の取得に pollingIntervalMillis を超える時間がかかる場合、現在の更新が完了するまで次の更新は開始されません。 この値を 0、Infinity、または負の値に設定すると、位置情報の自動更新が無効になります。トラッキング ID パラメータ（配送場所プロバイダの配送トラッキング ID など）またはフィルタ オプション（フリート位置情報プロバイダのビューポート境界や属性フィルタなど）が変更されると、新しい位置情報の更新が 1 回取得されます。 デフォルトかつ最小のポーリング間隔は 5,000 ミリ秒です。ポーリング間隔をより小さい正の値に設定すると、5000 が保存されて使用されます。
remainingPolylineCustomization 省略可	タイプ: (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional 残りのポリラインに適用されるカスタマイズ。残りのポリラインは、車両がまだ走行を開始していないルートの一部に対応します。 このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。 PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。 関数が指定されている場合、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、または位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。このポリラインに対応するデータが変更されたかどうかは関係ありません。 指定されたパラメータとその用途のリストについては、ShipmentPolylineCustomizationFunctionParams をご覧ください。
takenPolylineCustomization 省略可	タイプ: (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional 取得したポリラインに適用されるカスタマイズ。走行済みのポリラインは、車両がすでに通過したルートの一部に対応します。 このフィールドを使用して、カスタム スタイル（ポリラインの色など）とインタラクティビティ（クリック処理など）を指定します。 PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。 関数が指定されている場合、ポリラインの作成時に 1 回呼び出されます。（この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます）。また、この関数は、ポリラインの座標が変更されたとき、または位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。このポリラインに対応するデータが変更されたかどうかは関係ありません。 指定されたパラメータとその用途のリストについては、ShipmentPolylineCustomizationFunctionParams をご覧ください。
trackingId 省略可	タイプ: string optional 位置情報プロバイダがインスタンス化された直後に追跡するタスクのトラッキング ID。指定しない場合、位置情報プロバイダはタスクのトラッキングを開始しません。FleetEngineShipmentLocationProvider.trackingId を使用してトラッキング ID を設定し、トラッキングを開始します。

FleetEngineShipmentLocationProviderUpdateEvent インターフェース

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

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

プロパティ
taskTrackingInfo 省略可	タイプ: TaskTrackingInfo optional 更新によって返されるタスク トラッカー情報の構造。変更不可。