Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider クラス

配達車両位置プロバイダ。

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

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

FleetEngineDeliveryVehicleLocationProvider
FleetEngineDeliveryVehicleLocationProvider(options)
パラメータ: 
Fleet Engine 配送車両の新しい位置情報プロバイダを作成します。
deliveryVehicleId
タイプ:  string
この位置情報プロバイダが観測する車両の ID。車両を追跡するには、このフィールドを設定します。
shouldShowOutcomeLocations
タイプ:  boolean optional
必要に応じて、タスクの結果の場所を表示することをユーザーに許可します。
shouldShowTasks
タイプ:  boolean optional
必要に応じて、取得したタスクの表示をユーザーに許可する。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。古い車両の位置情報のしきい値。車両の最終更新日時がこのしきい値より古い場合、車両は表示されません。
taskFilterOptions
タスクの取得時に適用するフィルタ オプションを返します。
継承: isPolling, pollingIntervalMillis
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineDeliveryVehicleLocationProviderOptions インターフェース

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

配達車両位置プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールのコンシューマーのプロジェクト ID。
activePolylineCustomization optional
アクティブなポリラインにカスタマイズが適用されました。アクティブなポリラインは、車両が現在通過しているルートの一部に対応します。

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

    指定されたパラメータとその用途のリストについては、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
deliveryVehicleId optional
タイプ:  string optional
位置情報プロバイダがインスタンス化された直後に追跡される配達車両 ID。指定しない場合、位置情報プロバイダは車両のトラッキングを開始しません。FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId を使用して ID を設定し、トラッキングを開始します。
deliveryVehicleMarkerCustomization optional
タイプ:  (function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional
配送車両マーカーにカスタマイズを適用しました。

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

    指定されたパラメータとその用途のリストについては、DeliveryVehicleMarkerCustomizationFunctionParams をご覧ください。
plannedStopMarkerCustomization optional
タイプ:  (function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional
予定された停車場所マーカーにカスタマイズが適用されました。

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

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

この値を 0 に設定すると、位置情報の定期的な更新が無効になります。位置情報プロバイダがモニタリングしたパラメータのいずれかが変更されると、新しい位置情報の更新データが取得されます。

デフォルトのポーリング間隔は 5, 000 ミリ秒で、最小間隔です。ポーリング間隔をゼロ以外の小さい値に設定すると、5000 が使用されます。
remainingPolylineCustomization optional
カスタマイズが残りのポリラインに適用されました。残りのポリラインは、車両がまだ通過を開始していないルートの一部分に対応します。

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

    指定されたパラメータとその用途のリストについては、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
shouldShowOutcomeLocations optional
タイプ:  boolean optional
取得されたタスクの結果の場所を表示または非表示にするブール値。
shouldShowTasks optional
タイプ:  boolean optional
タスクの表示と非表示を切り替えるブール値。これを false に設定すると、ListTasks エンドポイントが呼び出されてタスクを取得できなくなります。直近の停車地のみが表示されます。
staleLocationThresholdMillis optional
タイプ:  number optional
古い車両の位置情報のしきい値。車両の最終更新日時がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間(ミリ秒)です。しきい値が 0 または Infinity より小さい場合、しきい値は無視され、車両の位置は古いとは見なされません。
takenPolylineCustomization optional
取得されたポリラインにカスタマイズを適用しました。取得されたポリラインは、車両がすでに通過したルートの一部に対応します。

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

    指定されたパラメータとその用途のリストについては、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
taskFilterOptions optional
タイプ:  FleetEngineTaskFilterOptions optional
タスクの取得時に適用するフィルタ オプション。オプションには、特定の車両、時間、タスクのステータスを含めることができます。
taskMarkerCustomization optional
タイプ:  (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
タスク マーカーにカスタマイズを適用しました。タスク マーカーは、配達車両に割り当てられた各タスクの計画された場所にレンダリングされます。

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

    指定されたパラメータとその用途のリストについては、TaskMarkerCustomizationFunctionParams をご覧ください。
taskOutcomeMarkerCustomization optional
タイプ:  function(TaskMarkerCustomizationFunctionParams): void optional
タスク結果マーカーに適用されたカスタマイズ。タスク結果マーカーは、配達車両に割り当てられた各タスクの実際の結果の場所にレンダリングされます。

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

    指定されたパラメータとその用途のリストについては、TaskMarkerCustomizationFunctionParams をご覧ください。

FleetEngineTaskFilterOptions インターフェース

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

Delivery Vehicle Location Provider のタスクのフィルタ オプション。

completionTimeFrom optional
タイプ:  Date optional
タスクの完了時間の下限(排他的)。指定した時間の後に完了したタスクをフィルタするために使用します。
completionTimeTo optional
タイプ:  Date optional
タスクの完了時間の上限(排他的)。指定した時間より前に完了したタスクをフィルタするために使用します。
state optional
タイプ:  string optional
タスクの状態。有効な値は OPEN または CLOSED です。

FleetEngineDeliveryVehicleLocationProviderUpdateEvent インターフェース

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

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

completedVehicleJourneySegments optional
タイプ:  Array<VehicleJourneySegment> optional
この車両が完了した工程セグメント。変更できません。
deliveryVehicle optional
タイプ:  DeliveryVehicle optional
更新によって返される配送車両のデータ構造。変更できません。
tasks optional
タイプ:  Array<Task> optional
このデリバリー ビークルによって提供されるタスクのリスト。変更できません。

FleetEngineDeliveryFleetLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider クラス

Delivery Fleet Location Provider。

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

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

FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
パラメータ: 
Fleet Engine によって追跡される車両の新しい位置情報プロバイダを作成します。
deliveryVehicleFilter
タイプ:  string optional
配達車両の取得時に適用されるフィルタ。
locationRestriction
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
配達車両を追跡する境界。境界が設定されていない場合、配達車両は追跡されません。場所に関係なくすべての配達車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。古い車両の位置情報のしきい値。車両の最終更新日時がこのしきい値より古い場合、車両は表示されません。
継承: isPolling, pollingIntervalMillis
継承: addListener
update
function(event)
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineDeliveryFleetLocationProviderOptions インターフェース

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

配達フリート位置情報プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールのコンシューマーのプロジェクト ID。
deliveryVehicleFilter optional
タイプ:  string optional
配達用車両を取得する際に適用するフィルタクエリ。このフィルタは Fleet Engine に直接渡されます。

サポートされている形式については、ListDeliveryVehiclesRequest.filter をご覧ください。

属性に対する有効なフィルタには、属性の接頭辞を付ける必要があります。たとえば、attributes.x = "y"attributes."x y" = "z" です。
deliveryVehicleMarkerCustomization optional
タイプ:  function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional
配送車両マーカーにカスタマイズを適用しました。

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

    指定されたパラメータとその用途のリストについては、DeliveryVehicleMarkerCustomizationFunctionParams をご覧ください。
locationRestriction optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
位置情報プロバイダがインスタンス化された直後に車両を追跡する、緯度と経度の境界です。設定されていない場合、位置情報プロバイダは車両のトラッキングを開始しません。FleetEngineDeliveryFleetLocationProvider.locationRestriction を使用して境界を設定し、トラッキングを開始します。場所に関係なくすべての配達車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis optional
タイプ:  number optional
古い車両の位置情報のしきい値。車両の最終更新日時がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間(ミリ秒)です。しきい値が 0 または Infinity より小さい場合、しきい値は無視され、車両の位置は古いとは見なされません。

FleetEngineDeliveryFleetLocationProviderUpdateEvent インターフェース

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

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

deliveryVehicles optional
タイプ:  Array<DeliveryVehicle> optional
クエリによって返される配送車両のリスト。変更できません。