chrome.printingMetrics

説明

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

権限

printingMetrics

対象

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

型

ColorMode

Enum

"BLACK_AND_WHITE"
モノクロ モードが使用されたことを示します。

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

DuplexMode

Enum

"ONE_SIDED"
片面印刷が使用されたことを示します。

"TWO_SIDED_LONG_EDGE"
両面印刷を使用し、長辺をめくるように指定します。

"TWO_SIDED_SHORT_EDGE"
両面印刷が使用され、短辺が反転していることを指定します。

MediaSize

プロパティ

  • 身長

    数値

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

  • vendorId

    文字列

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

  • 幅

    数値

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

Printer

プロパティ

  • name

    文字列

    プリンタの表示名。

  • target

    PrinterSource

    プリンタのソース。

  • uri

    文字列

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

PrinterSource

プリンタのソース。

Enum

"USER"
ユーザーがプリンタを追加したことを示します。

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

PrintJobInfo

プロパティ

  • completionTime

    数値

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

  • creationTime

    数値

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

  • id

    文字列

    ジョブの ID。

  • numberOfPages

    数値

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

  • プリンタ

    プリンタ

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

  • printer_status

    PrinterStatus

    Chrome 85 以降

    プリンタのステータス。

  • 設定

    PrintSettings

    印刷ジョブの設定。

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

  • sourceId

    string（省略可）

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

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

  • title

    文字列

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

PrintJobSource

印刷ジョブのソース。

Enum

"PRINT_PREVIEW"
ジョブがユーザーによって開始された [印刷プレビュー] ページから作成されたことを指定します。

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

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

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

PrintJobStatus

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

Enum

"FAILED"
なんらかのエラーが原因で印刷ジョブが中断されたことを示します。

"CANCELED"
印刷ジョブがユーザーまたは API によってキャンセルされたことを示します。

"PRINTED"
印刷ジョブがエラーなしで印刷されたことを示します。

PrintSettings

プロパティ

  • 色

    ColorMode

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

  • コピー数

    数値

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

  • Duplex

    DuplexMode

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

  • mediaSize

    MediaSize

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

Methods

getPrintJobs()

Promise 
chrome.printingMetrics.getPrintJobs(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    (jobs: PrintJobInfo[])=>void

戻り値

  • Promise<PrintJobInfo[]>

    Chrome 96 以降

    Promise は Manifest V3 以降でサポートされていますが、コールバックは下位互換性のために提供されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されたのと同じ型で解決されます。

イベント

onPrintJobFinished

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

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

パラメータ

  • callback

    機能

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

    (jobInfo: PrintJobInfo)=>void