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、無限大、または負の値に設定すると、位置情報の自動更新が無効になります。新しい位置情報の更新は、トラッキング ID パラメータ（配送場所プロバイダの配送追跡 ID など）またはフィルタリング オプション（ビューポートの境界やフリートの位置情報プロバイダの属性フィルタなど）が変更された場合に 1 回取得されます。

デフォルトの最小ポーリング間隔は 5,000 ミリ秒です。ポーリング間隔をより低い正の値に設定すると、5, 000 が保存され、使用されます。
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
更新によって返されるタスク トラッキング情報の構造。変更できません。