chrome.printingMetrics

説明

chrome.printingMetrics API を使用して、印刷の使用状況に関するデータを取得します。

権限

printingMetrics

対象

Chrome 79 以降 ChromeOS のみ ポリシーが必要

型

ColorMode

列挙型

"BLACK_AND_WHITE"
白黒モードが使用されたことを指定します。

"COLOR"
カラーモードが使用されたことを指定します。

DuplexMode

列挙型

「ONE_SIDED」
片面印刷が使用されたことを指定します。

"TWO_SIDED_LONG_EDGE"
両面印刷が使用され、長辺で反転されたことを指定します。

"TWO_SIDED_SHORT_EDGE"
両面印刷が使用され、縦長で反転されたことを指定します。

MediaSize

プロパティ

  • height

    数値

    印刷に使用するメディアの高さ（マイクロメートル単位）。

  • vendorId

    文字列

    ベンダーが提供する ID（「iso_a3_297x420mm」や「na_index-3x5_3x5in」など）。有効な値は「media」IPP 属性の値で、IANA ページで確認できます。

  • 幅

    数値

    印刷に使用するメディアの幅（マイクロメートル単位）。

Printer

プロパティ

  • name

    文字列

    プリンタの表示名。

  • source

    PrinterSource

    プリンタのソース。

  • uri

    文字列

    プリンタのフルパス。プロトコル、ホスト名、ポート、キューが含まれます。

PrinterSource

プリンタのソース。

列挙型

「USER」
プリンタがユーザーによって追加されたことを指定します。

「POLICY」
プリンタがポリシー経由で追加されたことを指定します。

PrintJobInfo

プロパティ

  • completionTime

    数値

    ジョブの完了時間（Unix エポックからの経過時間、ミリ秒単位）。

  • creationTime

    数値

    ジョブの作成時間（Unix エポックからの経過時間（ミリ秒））。

  • id

    文字列

    ジョブの ID。

  • numberOfPages

    数値

    ドキュメントのページ数。

  • プリンタ

    プリンタ

    ドキュメントを印刷したプリンタに関する情報。

  • printer_status

    PrinterStatus

    Chrome 85 以降

    プリンタのステータス。

  • 設定

    PrintSettings

    印刷ジョブの設定。

  • 印刷ジョブを開始したユーザーを示すソース。

  • sourceId

    文字列 省略可

    ソースの ID。ソースが PRINT_PREVIEW または ANDROID_APP の場合は null。

  • ステータス

    PrintJobStatus

    ジョブの最終ステータス。

  • title

    文字列

    印刷されたドキュメントのタイトル。

PrintJobSource

印刷ジョブのソース。

列挙型

「PRINT_PREVIEW」
ユーザーが開始した印刷プレビュー ページからジョブが作成されたことを指定します。

「ANDROID_APP」
ジョブが Android アプリから作成されたことを指定します。

「EXTENSION」
Chrome API を介して拡張機能によってジョブが作成されたことを指定します。

「ISOLATED_WEB_APP」
API を介して独立したウェブアプリによってジョブが作成されたことを指定します。

PrintJobStatus

印刷ジョブの最終ステータスを指定します。

列挙型

「FAILED」
エラーが発生したため、印刷ジョブが中断されたことを指定します。

「CANCELED」
印刷ジョブがユーザーまたは API を介してキャンセルされたことを指定します。

「PRINTED」
印刷ジョブがエラーなく印刷されたことを指定します。

PrintSettings

プロパティ

  • 色

    ColorMode

    リクエストされたカラーモード。

  • コピー

    数値

    リクエストされたコピーの数。

  • Duplex

    DuplexMode

    リクエストされた全二重モード。

  • mediaSize

    MediaSize

    リクエストされたメディアサイズ。

メソッド

getPrintJobs()

Promise 
chrome.printingMetrics.getPrintJobs(
  callback?: function,
): Promise<PrintJobInfo[]>

完了した印刷ジョブのリストを返します。

パラメータ

  • callback

    関数 省略可

    callback パラメータは次のようになります。 

    (jobs: PrintJobInfo[]) => void

戻り値

  • Promise<PrintJobInfo[]>

    Chrome 96 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

イベント

onPrintJobFinished

chrome.printingMetrics.onPrintJobFinished.addListener(
  callback: function,
)

印刷ジョブが完了したときに発生するイベント。これには、FAILED、CANCELED、PRINTED などの終了ステータスが含まれます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (jobInfo: PrintJobInfo) => void