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 Web Token を提供します。 |
projectId | タイプ: string Google Cloud コンソールから取得したコンシューマのプロジェクト ID。 |
activePolylineCustomization optional | タイプ: (function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional アクティブなポリラインに適用されるカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。 このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
|
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 が使用されます。 |
remainingPolylineCustomization optional | タイプ: (function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 残りのポリラインに適用されるカスタマイズ。残りのポリラインは、車両がまだ走行していないルートの部分に対応しています。 このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
|
shouldShowOutcomeLocations optional | タイプ: boolean optional フェッチされたタスクの結果の場所を表示または非表示にするブール値。 |
shouldShowTasks optional | タイプ: boolean optional タスクを表示または非表示にするブール値。これを false に設定すると、ListTasks エンドポイントが呼び出され、タスクが取得されなくなります。今後の停留所のみが表示されます。 |
staleLocationThresholdMillis optional | タイプ: number optional 古い車両位置情報のしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間(ミリ秒単位)です。しきい値が 0 未満または 無限大の場合、しきい値は無視され、車両の位置情報は古い位置情報と見なされません。 |
takenPolylineCustomization optional | タイプ: (function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional 撮影したポリラインに適用されたカスタマイズ。走行済みのポリラインは、車両がすでに走行したルートの一部に対応します。 このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
|
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 |
メソッド | |
---|---|
継承: addListener |
イベント | |
---|---|
update | function(event) Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。 |
継承: ispollingchange |
FleetEngineDeliveryFleetLocationProviderOptions インターフェース
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
インターフェース
配送車両の位置情報プロバイダのオプション。
プロパティ | |
---|---|
authTokenFetcher | タイプ: AuthTokenFetcher Fleet Engine に対してクライアントを認証するための JSON Web Token を提供します。 |
projectId | タイプ: string Google Cloud コンソールから取得したコンシューマのプロジェクト 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 未満または無限大の場合、しきい値は無視され、車両の位置情報は古いと見なされません。 |
FleetEngineDeliveryFleetLocationProviderUpdateEvent インターフェース
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
インターフェース
FleetEngineDeliveryFleetLocationProvider.update
イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
プロパティ | |
---|---|
deliveryVehicles optional | タイプ: Array<DeliveryVehicle> optional クエリによって返される配送車両のリスト。変更不可。 |