browser.printingMetrics

説明

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

権限

printingMetrics

対象

Chrome 79 以降 Chrome 148 以降の browser.* 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 ページで確認できます。

  • width

    数値

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

Printer

プロパティ

  • name

    文字列

    プリンタの表示名。

  • ソース

    PrinterSource

    プリンタのソース。

  • uri

    文字列

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

PrinterSource

プリンタのソース。

列挙型

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

"POLICY"
プリンタがポリシーによって追加されたことを示します。

PrintJobInfo

プロパティ

  • completionTime

    数値

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

  • creationTime

    数値

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

  • id

    文字列

    ジョブの ID。

  • numberOfPages

    数値

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

  • プリンタ

    プリンタ

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

  • printer_status

    PrinterStatus

    Chrome 85 以降 Chrome 148 以降の browser.*

    プリンターのステータス。

  • 設定

    PrintSettings

    印刷ジョブの設定。

  • ソース

    PrintJobSource

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

  • 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()

browser.printingMetrics.getPrintJobs(): Promise<PrintJobInfo[]>

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

戻り値

  • Promise<PrintJobInfo[]>

    Chrome 96 以降 Chrome 148 以降の browser.*

イベント

onPrintJobFinished

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

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

パラメータ

  • callback

    関数

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

    (jobInfo: PrintJobInfo) => void