Chrome で標準化された browser.* 名前空間がサポートされるようになりました（Chrome 148 以降で利用可能）。ドキュメントは順次更新されます。詳しくは、移行ガイドをご覧ください。

Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

browser.printing

説明

chrome.printing API を使用して、Chromebook にインストールされているプリンタに印刷ジョブを送信します。

権限

printing

対象

Chrome 81 以降 Chrome 148 以降の browser.* ChromeOS のみ

すべての browser.printing メソッドとイベントでは、拡張機能マニフェストで "printing" 権限を宣言する必要があります。次に例を示します。

{
  "name": "My extension",
  ...
  "permissions": [
    "printing"
  ],
  ...
}

例

以下の例は、printing 名前空間の各メソッドの使用方法を示しています。このコードは、extensions-samples GitHub リポジトリの api-samples/printing からコピーされたか、またはそれに基づいています。

cancelJob()

この例では、onJobStatusChanged ハンドラを使用して、jobStatus が PENDING でも IN_PROGRESS でもない場合に [キャンセル] ボタンを非表示にしています。なお、一部のネットワークや、Chromebook がプリンタに直接接続されている場合は、これらの状態がすぐに切り替わるため、キャンセルボタンが十分に表示されないことがあります。これは、印刷の例を大幅に簡略化したものです。

browser.printing.onJobStatusChanged.addListener((jobId, status) => {
  const cancelButton = document.getElementById("cancelButton");
  cancelButton.addEventListener('click', () => {
    browser.printing.cancelJob(jobId).then((response) => {
      if (response !== undefined) {
        console.log(response.status);
      }
      if (browser.runtime.lastError !== undefined) {
        console.log(browser.runtime.lastError.message);
      }
    });
  });
  if (status !== "PENDING" && status !== "IN_PROGRESS") {
    cancelButton.style.visibility = 'hidden';
  } else {
    cancelButton.style.visibility = 'visible';
  }
}

getPrinters() and getPrinterInfo()

プリンタ情報を取得するには、getPrinters() を呼び出して取得するプリンタ ID が必要であるため、これらの関数には 1 つの例が使用されています。この例では、デフォルトのプリンタの名前と説明をコンソールに記録します。これは、印刷の例を簡略化したものです。

const printers = await browser.printing.getPrinters();
const defaultPrinter = printers.find((printer) => {
  const printerInfo = await browser.printing.getPrinterInfo(printer.id);
  return printerInfo.isDefault;
}
console.log(`Default printer: ${defaultPrinter.name}.\n\t${defaultPrinter.description}`);

submitJob()

submitJob() メソッドには、次の 3 つが必要です。

使用するプリンタの機能を指定する ticket 構造。ユーザーが利用可能な機能から選択する必要がある場合は、getPrinterInfo() を使用して特定のプリンタの機能を取得できます。
SubmitJobRequest 構造。使用するプリンタと、印刷するファイルまたはデータを指定します。この構造には、ticket 構造への参照が含まれています。
印刷するファイルまたはデータの blob。

submitJob() を呼び出すと、印刷の確認を求めるダイアログボックスが表示されます。PrintingAPIExtensionsAllowlist を使用して確認を省略します。

これは、印刷の例を簡略化したものです。ticket が SubmitJobRequest 構造体にアタッチされ（8 行目）、印刷するデータが blob に変換されている（10 行目）ことに注目してください。プリンタの ID を取得する（1 行目）のは、ここに示されているよりもサンプルの方が複雑です。

const defaultPrinter = getDefaultPrinter();
const ticket = getPrinterTicket(defaultPrinter);
const arrayBuffer = getPrintData();
const submitJobRequest = {
  job: {
    printerId: defaultPrinter,
    title: 'test job',
    ticket: ticket,
    contentType: 'application/pdf',
    document: new Blob([new Uint8Array(arrayBuffer)], {
      type: 'application/pdf'
    });
  }
};

browser.printing.submitJob(submit>JobRequest, (response) = {
  if (response !== undefined) {
    console.log(response.status);
  }
  if (browser.runtime.lastError !== undefined) {
    console.log(browser.runtime.lastError.message);
  }
});

ロール印刷

この例では、レシート印刷でよく使用される連続（ロール）印刷用のプリンタチケットを作成する方法を示します。ロール印刷用の submitJobRequest オブジェクトは、submitJob() の例に示したものと同じです。

用紙カットのデフォルト値を変更する必要がある場合は、vendor_ticket_item キーを使用します。（デフォルトはプリンタによって異なります）。値を変更するには、1 つのメンバー（id が 'finishings' であるオブジェクト）を含む配列を指定します。値は、印刷の終了時にロールをカットするプリンタの場合は 'trim'、印刷ジョブを切り取る必要があるプリンタの場合は 'none' になります。

const ticket = {
  version: '1.0',
  print: {
    vendor_ticket_item: [{id: 'finishings', value: 'trim'}],
    color: {type: 'STANDARD_MONOCHROME'},
    duplex: {type: 'NO_DUPLEX'},
    page_orientation: {type: 'PORTRAIT'},
    copies: {copies: 1},
    dpi: {horizontal_dpi: 300, vertical_dpi: 300},
    media_size: {
      width_microns: 72320,
      height_microns: 100000
    },
    collate: {collate: false}
  }
};

一部のプリンタは "finishings" オプションをサポートしていません。プリンタが対応しているかどうかを確認するには、getPrinterInfo() を呼び出して、"finishings/11" の "display_name" を探します。

"vendor_capability": [
  {
    "display_name": "finishings/11",
    "id": "finishings/11",
    "type": "TYPED_VALUE",
    "typed_value_cap": {
      "value_type": "BOOLEAN"
    }
  },
  ...
]

チケットの media_size キーの値は、プリンタごとに異なります。適切なサイズを選択するには、getPrinterInfo() を呼び出します。返される GetPrinterResponse には、"media_size"."option" でサポートされているメディアサイズの配列が含まれます。"is_continuous_feed" 値が true のオプションを選択します。チケットの高さと幅の値を使用します。

"media_size": {
  "option": [
  {
    "custom_display_name": "",
    "is_continuous_feed": true,
    "max_height_microns": 2000000,
    "min_height_microns": 25400,
    "width_microns": 50800
  },
  ...
  ]
}

型

GetPrinterInfoResponse

プロパティ

機能

オブジェクト（省略可）

CDD 形式のプリンタ機能。プロパティが欠落している可能性があります。
ステータス

PrinterStatus

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

JobStatus

印刷ジョブのステータス。

列挙型

「PENDING」
印刷ジョブは Chrome 側で受信されましたが、まだ処理されていません。

"IN_PROGRESS"
印刷ジョブが印刷のために送信されました。

"FAILED"
エラーにより印刷ジョブが中断されました。

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

"PRINTED"
印刷ジョブがエラーなしで印刷されました。

Printer

プロパティ

description

文字列

プリンタの説明（人が読める形式）。
id

文字列

プリンタの識別子。デバイス上のプリンタ間で一意であることが保証されます。
isDefault

ブール値

プリンタが DefaultPrinterSelection ルールに適合するかどうかを示すフラグ。複数のプリンタがフラグ付けされる可能性があることに注意してください。
name

文字列

プリンタの名前。
recentlyUsedRank

number 省略可

Chrome からの印刷にプリンタが最近使用されたことを示す値。値が小さいほど、プリンタが最近使用されたことを示します。最小値は 0 です。値がない場合は、プリンタが最近使用されていないことを示します。この値は、プリンタ間で一意であることが保証されます。
ソース

PrinterSource

プリンタのソース（ユーザーまたはポリシーで設定）。
uri

文字列

プリンタの URI。この設定は、拡張機能がユーザーのプリンタを選択するために使用できます。

PrinterSource

プリンタのソース。

列挙型

"USER"
プリンターはユーザーによって追加されました。

"POLICY"
プリンタはポリシーによって追加されました。

PrinterStatus

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

列挙型

"DOOR_OPEN"
プリンタのドアが開いています。プリンタは引き続き印刷ジョブを受け付けます。

"TRAY_MISSING"
プリンタのトレイがありません。プリンタは引き続き印刷ジョブを受け付けます。

"OUT_OF_INK"
プリンタのインクが切れています。プリンタは引き続き印刷ジョブを受け付けます。

"OUT_OF_PAPER"
プリンタに用紙がありません。プリンタは引き続き印刷ジョブを受け付けます。

"OUTPUT_FULL"
プリンタの出力エリア（トレイなど）がいっぱいです。プリンタは引き続き印刷ジョブを受け付けます。

"PAPER_JAM"
プリンタで紙詰まりが発生しています。プリンタは引き続き印刷ジョブを受け付けます。

"GENERIC_ISSUE"
一般的な問題。プリンタは引き続き印刷ジョブを受け付けます。

"STOPPED"
プリンタは停止しており、印刷は行われませんが、印刷ジョブは引き続き受け付けます。

「UNREACHABLE」
プリンタにアクセスできず、印刷ジョブを受け付けません。

"EXPIRED_CERTIFICATE"
SSL 証明書の有効期限が切れています。プリンタがジョブを受け入れるが、ジョブが失敗する。

「利用可能」
プリンタは利用可能です。

SubmitJobRequest

プロパティ

ジョブ

PrintJob

送信する印刷ジョブ。サポートされているコンテンツタイプは「application/pdf」と「image/png」です。Cloud Job Ticket には、FitToPageTicketItem、PageRangeTicketItem、ReverseOrderTicketItem フィールドを含めないでください。これらのフィールドはネイティブ印刷には関係ありません。VendorTicketItem は任意です。他のすべてのフィールドは必須です。

SubmitJobResponse

プロパティ

jobId

文字列省略可

作成された印刷ジョブの ID。これは、デバイス上のすべての印刷ジョブで一意の識別子です。ステータスが OK でない場合、jobId は null になります。
ステータス

SubmitJobStatus

リクエストのステータス。

SubmitJobStatus

submitJob リクエストのステータス。

列挙型

「OK」
送信された印刷ジョブリクエストが承認されました。

"USER_REJECTED"
送信された印刷ジョブリクエストがユーザーによって拒否されました。

プロパティ

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

1 分間に getPrinterInfo を呼び出すことができる最大回数。

値

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

1 分間に submitJob を呼び出すことができる最大回数。

値

メソッド

cancelJob()

browser.printing.cancelJob(
  jobId: string,
): Promise<void>

以前に送信されたジョブをキャンセルします。

パラメータ

jobId

文字列

キャンセルする印刷ジョブの ID。これは、SubmitJobResponse で受信した ID と同じにする必要があります。

戻り値

Promise<void>

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

getJobStatus()

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

browser.printing.getJobStatus(
  jobId: string,
): Promise<JobStatus>

印刷ジョブのステータスを返します。指定された jobId の印刷ジョブが存在しない場合、この呼び出しはランタイムエラーで失敗します。jobId: ステータスを返す印刷ジョブの ID。これは、SubmitJobResponse で受信した ID と同じにする必要があります。

パラメータ

jobId

文字列

戻り値

Promise<JobStatus>

getPrinterInfo()

browser.printing.getPrinterInfo(
  printerId: string,
): Promise<GetPrinterInfoResponse>

プリンターのステータスと機能を CDD 形式で返します。指定された ID のプリンタがインストールされていない場合、この呼び出しはランタイムエラーで失敗します。

パラメータ

printerId

文字列

戻り値

Promise<GetPrinterInfoResponse>

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

getPrinters()

browser.printing.getPrinters(): Promise<Printer[]>

デバイスで使用可能なプリンタのリストを返します。これには、手動で追加したプリンタ、エンタープライズプリンタ、検出されたプリンタが含まれます。

戻り値

Promise<Printer[]>

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

submitJob()

browser.printing.submitJob(
  request: SubmitJobRequest,
): Promise<SubmitJobResponse>

印刷ジョブを送信します。拡張機能が PrintingAPIExtensionsAllowlist ポリシーに記載されていない場合、ユーザーは印刷ジョブを承認するよう求められます。 Chrome 120 より前では、この関数は Promise を返しませんでした。

パラメータ

リクエスト

SubmitJobRequest

戻り値

Promise<SubmitJobResponse>

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

イベント

onJobStatusChanged

browser.printing.onJobStatusChanged.addListener(
  callback: function,
)

ジョブのステータスが変更されたときに発生するイベント。これは、この拡張機能によって作成されたジョブに対してのみ呼び出されます。

パラメータ

callback

関数

callback パラメータは次のようになります。
```
(jobId: string, status: JobStatus) =& gt;void
```
- jobId
  
  文字列
- ステータス
  
  JobStatus

browser.printing コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

説明

権限

対象

例

cancelJob()

getPrinters() and getPrinterInfo()

submitJob()

ロール印刷

型

GetPrinterInfoResponse

プロパティ

JobStatus

列挙型

Printer

プロパティ

PrinterSource

列挙型

PrinterStatus

列挙型

SubmitJobRequest

プロパティ

SubmitJobResponse

プロパティ

SubmitJobStatus

列挙型

プロパティ

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

値

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

値

メソッド

cancelJob()

パラメータ

戻り値

getJobStatus()

パラメータ

戻り値

getPrinterInfo()

パラメータ

戻り値

getPrinters()

戻り値

submitJob()

パラメータ

戻り値

イベント

onJobStatusChanged

パラメータ

browser.printing