chrome.printingMetrics

Description

Use the chrome.printingMetrics API to fetch data about printing usage.

Permissions

printingMetrics

Availability

Chrome 79+ ChromeOS only Requires policy

Types

ColorMode

Enum

"BLACK_AND_WHITE"
Specifies that black and white mode was used.

"COLOR"
Specifies that color mode was used.

DuplexMode

Enum

"ONE_SIDED"
Specifies that one-sided printing was used.

"TWO_SIDED_LONG_EDGE"
Specifies that two-sided printing was used, flipping on long edge.

"TWO_SIDED_SHORT_EDGE"
Specifies that two-sided printing was used, flipping on short edge.

MediaSize

Properties

  • height

    number

    Height (in micrometers) of the media used for printing.

  • vendorId

    string

    Vendor-provided ID, e.g. "iso_a3_297x420mm" or "na_index-3x5_3x5in". Possible values are values of "media" IPP attribute and can be found on IANA page .

  • width

    number

    Width (in micrometers) of the media used for printing.

Printer

Properties

  • name

    string

    Displayed name of the printer.

  • source

    PrinterSource

    The source of the printer.

  • uri

    string

    The full path for the printer. Contains protocol, hostname, port, and queue.

PrinterSource

The source of the printer.

Enum

"USER"
Specifies that the printer was added by user.

"POLICY"
Specifies that the printer was added via policy.

PrintJobInfo

Properties

  • completionTime

    number

    The job completion time (in milliseconds past the Unix epoch).

  • creationTime

    number

    The job creation time (in milliseconds past the Unix epoch).

  • id

    string

    The ID of the job.

  • numberOfPages

    number

    The number of pages in the document.

  • printer

    Printer

    The info about the printer which printed the document.

  • printer_status

    PrinterStatus

    Chrome 85+

    The status of the printer.

  • settings

    PrintSettings

    The settings of the print job.

  • Source showing who initiated the print job.

  • sourceId

    string optional

    ID of source. Null if source is PRINT_PREVIEW or ANDROID_APP.

  • The final status of the job.

  • title

    string

    The title of the document which was printed.

PrintJobSource

The source of the print job.

Enum

"PRINT_PREVIEW"
Specifies that the job was created from the Print Preview page initiated by the user.

"ANDROID_APP"
Specifies that the job was created from an Android App.

"EXTENSION"
Specifies that the job was created by extension via Chrome API.

"ISOLATED_WEB_APP"
Specifies that the job was created by an Isolated Web App via API.

PrintJobStatus

Specifies the final status of the print job.

Enum

"FAILED"
Specifies that the print job was interrupted due to some error.

"CANCELED"
Specifies that the print job was canceled by the user or via API.

"PRINTED"
Specifies that the print job was printed without any errors.

PrintSettings

Properties

  • color

    ColorMode

    The requested color mode.

  • copies

    number

    The requested number of copies.

  • duplex

    DuplexMode

    The requested duplex mode.

  • mediaSize

    MediaSize

    The requested media size.

Methods

getPrintJobs()

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

Returns the list of the finished print jobs.

Parameters

Returns

  • Promise<PrintJobInfo[]>

    Chrome 96+

    Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.

Events

onPrintJobFinished

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

Event fired when the print job is finished. This includes any of termination statuses: FAILED, CANCELED and PRINTED.

Parameters