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
| |
Methods | |
|---|---|
継承される:
addListener
|
イベント | |
|---|---|
error |
function(event)引数:
ロケーションのプロバイダでエラーが発生した場合にトリガーされるイベント。 |
update |
function(event)フリート エンジンのデータ更新リクエストが完了したときにトリガーされるイベント。 |
継承される:
ispollingchange
| |
FleetEngineDeliveryVehicleLocationProviderOptions インターフェース
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions インターフェース
配送車両の位置情報プロバイダのオプション。
プロパティ | |
|---|---|
authTokenFetcher |
タイプ:
AuthTokenFetcherフリート エンジンにクライアントを認証するための JSON Web Token を提供します。 |
projectId |
タイプ:
stringGoogle Cloud Console にあるコンシューマのプロジェクト ID。 |
deliveryVehicleId optional |
タイプ:
string optional位置情報プロバイダをインスタンス化した直後に追跡する配達車両 ID。指定しない場合、位置情報プロバイダは車両のトラッキングを開始しません。 FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId を使用して ID を設定し、トラッキングを開始します。 |
deliveryVehicleMarkerCustomization optional |
タイプ:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional配送車両マーカーに適用されるカスタマイズ。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
|
plannedStopMarkerCustomization optional |
タイプ:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optionalカスタマイズした予定マーカーにカスタマイズが適用されます。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
|
pollingIntervalMillis optional |
タイプ:
number optional位置情報の更新を取得する間隔の最小値（ミリ秒単位）。位置情報の更新データの取得に pollingIntervalMillis 時間以上かかる場合、次の位置情報の更新は、現在の更新が完了するまで開始されません。この値を 0 に設定すると、定期的な位置情報の更新が無効になります。位置情報プロバイダが監視しているパラメータのいずれかが変更された場合、新しい位置情報の更新が取得されます。 デフォルトのポーリング間隔は 5, 000 ミリ秒、最小間隔です。ポーリング間隔をゼロ以外の小さい値に設定すると、5000 が使用されます。 |
shouldShowOutcomeLocations optional |
タイプ:
boolean optional取得されたタスクの結果の場所を表示または非表示にするブール値。 |
shouldShowTasks optional |
タイプ:
boolean optionalタスクを表示または非表示にするブール値。これを false に設定すると、タスクを取得するために ListTasks エンドポイントが呼び出されなくなります。予定されている停車場所のみが表示されます。 |
staleLocationThresholdMillis optional |
タイプ:
number optional車両位置情報の古いしきい値。最後に車両が更新された位置情報がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間（ミリ秒）です。しきい値が 0 未満または Infinity の場合、しきい値は無視され、車両の位置情報は古いとみなされません。 |
taskFilterOptions optional |
タイプ:
FleetEngineTaskFilterOptions optionalタスクを取得する際に適用するフィルタ オプション。特定の車両、時刻、タスクのステータスを指定できます。 |
taskMarkerCustomization optional |
タイプ:
(function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optionalカスタマイズをタスク マーカーに適用しました。タスクマーカーは、配送車両に割り当てられた各タスクの計画場所にレンダリングされます。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
|
taskOutcomeMarkerCustomization optional |
タイプ:
function(TaskMarkerCustomizationFunctionParams): void optionalカスタマイズがタスクの結果マーカーに適用されました。タスクの結果を示すマーカーは、配送車両に割り当てられた各タスクの実際の結果の位置に表示されます。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
|
FleetEngineTaskFilterOptions インターフェース
google.maps.journeySharing.FleetEngineTaskFilterOptions インターフェース
配送車両の位置情報プロバイダのタスクにフィルタを適用できます。
プロパティ | |
|---|---|
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 |
この配達車両によって処理されるタスクのリスト。変更不可。 |
FleetEngineDeliveryFleetLocationProvider クラス
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider クラス
配送フリートの位置情報プロバイダ。
このクラスは 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
| |
Methods | |
|---|---|
継承される:
addListener
|
イベント | |
|---|---|
update |
function(event)フリート エンジンのデータ更新リクエストが完了したときにトリガーされるイベント。 |
継承される:
ispollingchange
| |
FleetEngineDeliveryFleetLocationProviderOptions インターフェース
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions インターフェース
配送フリートの位置情報プロバイダのオプション。
プロパティ | |
|---|---|
authTokenFetcher |
タイプ:
AuthTokenFetcherフリート エンジンにクライアントを認証するための JSON Web Token を提供します。 |
projectId |
タイプ:
stringGoogle Cloud Console にあるコンシューマのプロジェクト ID。 |
deliveryVehicleFilter optional |
タイプ:
string optional配達車両の取得時に適用するフィルタクエリ。このフィルタは、Fleet Engine に直接渡されます。 サポートされている形式については、ListDeliveryVehiclesRequest.filter をご覧ください。 属性の有効なフィルタには接頭辞「attributes」が必要です。たとえば、 attributes.x = "y" や attributes."x y" = "z" です。 |
deliveryVehicleMarkerCustomization optional |
タイプ:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional配送車両マーカーに適用されるカスタマイズ。 このフィールドを使用して、カスタム スタイル（マーカー アイコンなど）とインタラクティビティ（クリック処理など）を指定します。
|
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クエリによって返された配送車両のリスト。変更不可。 |