chrome.printing

refresh date: 2026-09-25 robots: noindex

สำคัญ: API นี้ใช้ได้ใน ChromeOS เท่านั้น

คำอธิบาย

ใช้ chrome.printing API เพื่อส่งงานพิมพ์ไปยังเครื่องพิมพ์ที่ติดตั้งใน Chromebook

สิทธิ์

printing

ความพร้อมใช้งาน

Chrome 81 ขึ้นไป ChromeOS เท่านั้น

ไฟล์ Manifest

เมธอดและเหตุการณ์ chrome.printing ทั้งหมดกำหนดให้คุณต้องประกาศสิทธิ์ "printing" ในไฟล์ Manifest ของส่วนขยาย เช่น

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

ตัวอย่าง

ตัวอย่างด้านล่างแสดงการใช้แต่ละเมธอดในเนมสเปซการพิมพ์ โค้ดนี้คัดลอกมาจากหรืออิงตาม api-samples/printing ในที่เก็บ GitHub ของ extensions-samples

cancelJob()

ตัวอย่างนี้ใช้แฮนเดิล onJobStatusChanged เพื่อซ่อนปุ่ม "ยกเลิก" เมื่อ jobStatus ไม่ใช่ PENDING หรือ IN_PROGRESS โปรดทราบว่าในบางเครือข่ายหรือเมื่อเชื่อมต่อ Chromebook กับเครื่องพิมพ์โดยตรง สถานะเหล่านี้อาจผ่านไปเร็วเกินกว่าที่ปุ่มยกเลิกจะปรากฏนานพอที่จะเรียกใช้ได้ นี่เป็นตัวอย่างการพิมพ์ที่เข้าใจง่าย

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

getPrinters() and getPrinterInfo()

เราใช้ตัวอย่างเดียวสำหรับฟังก์ชันเหล่านี้เนื่องจากการรับข้อมูลเครื่องพิมพ์ต้องใช้รหัสเครื่องพิมพ์ ซึ่งดึงมาได้โดยการเรียกใช้ getPrinters() ตัวอย่างนี้จะบันทึกชื่อและคำอธิบายของเครื่องพิมพ์เริ่มต้นลงในคอนโซล นี่คือตัวอย่างการพิมพ์เวอร์ชันที่เข้าใจง่าย

​​const printers = await chrome.printing.getPrinters();
const defaultPrinter = printers.find((printer) => {
  const printerInfo = await chrome.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) การรับรหัสของเครื่องพิมพ์ (บรรทัดที่ 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'
    });
  }
};

chrome.printing.submitJob(submitJobRequest, (response) => {
  if (response !== undefined) {
    console.log(response.status);
  }
  if (chrome.runtime.lastError !== undefined) {
    console.log(chrome.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() และมองหา "display_name" ของ "finishings/11"

"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" เป็นจริง ใช้ค่าความสูงและความกว้างสำหรับตั๋ว

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

ประเภท

GetPrinterInfoResponse

พร็อพเพอร์ตี้

• ความสามารถ

  object ไม่บังคับ

  ความสามารถของเครื่องพิมพ์ในรูปแบบ CDD พร็อพเพอร์ตี้อาจหายไป

• สถานะ

  PrinterStatus

  สถานะของเครื่องพิมพ์

JobStatus

สถานะของงานพิมพ์

ค่าแจกแจง

"PENDING"
Chrome ได้รับงานพิมพ์แล้ว แต่ยังไม่ได้ประมวลผล

"IN_PROGRESS"
ระบบส่งงานพิมพ์ไปพิมพ์แล้ว

"FAILED"
งานพิมพ์ถูกขัดจังหวะเนื่องจากมีข้อผิดพลาดบางอย่าง

"CANCELED"
ผู้ใช้หรือ API ยกเลิกงานพิมพ์

"PRINTED"
พิมพ์งานพิมพ์โดยไม่มีข้อผิดพลาด

Printer

พร็อพเพอร์ตี้

• คำอธิบาย

  สตริง

  คำอธิบายเครื่องพิมพ์ที่มนุษย์อ่านได้

• id

  สตริง

  ตัวระบุของเครื่องพิมพ์ ซึ่งรับประกันว่าจะไม่ซ้ำกันในบรรดาเครื่องพิมพ์ในอุปกรณ์

• isDefault

  บูลีน

  แฟล็กที่แสดงว่าเครื่องพิมพ์เป็นไปตามกฎ DefaultPrinterSelection หรือไม่ โปรดทราบว่าระบบอาจแจ้งว่าเครื่องพิมพ์หลายเครื่องมีปัญหา

• name

  สตริง

  ชื่อเครื่องพิมพ์

• recentlyUsedRank

  number ไม่บังคับ

  ค่าที่แสดงว่ามีการใช้เครื่องพิมพ์เพื่อพิมพ์จาก Chrome ล่าสุดเมื่อใด ยิ่งค่าต่ำลงเท่าใด ก็ยิ่งแสดงว่ามีการใช้เครื่องพิมพ์เมื่อไม่นานมานี้มากขึ้นเท่านั้น ค่าต่ำสุดคือ 0 ค่าที่ขาดหายไปบ่งบอกว่าไม่ได้ใช้เครื่องพิมพ์เมื่อเร็วๆ นี้ ค่านี้รับประกันว่าจะไม่ซ้ำกันในเครื่องพิมพ์แต่ละเครื่อง

• source

  PrinterSource

  แหล่งที่มาของเครื่องพิมพ์ (ผู้ใช้หรือนโยบายที่กำหนดค่าไว้)

• uri

  สตริง

  URI ของเครื่องพิมพ์ ส่วนขยายสามารถใช้ฟีเจอร์นี้เพื่อเลือกเครื่องพิมพ์ให้ผู้ใช้ได้

PrinterSource

แหล่งที่มาของเครื่องพิมพ์

ค่าแจกแจง

"USER"
ผู้ใช้เพิ่มเครื่องพิมพ์

"POLICY"
เพิ่มเครื่องพิมพ์ผ่านนโยบาย

PrinterStatus

สถานะของเครื่องพิมพ์

ค่าแจกแจง

"DOOR_OPEN"
ฝาเครื่องพิมพ์เปิดอยู่ เครื่องพิมพ์ยังคงรับงานพิมพ์

"TRAY_MISSING"
ไม่มีถาดของเครื่องพิมพ์ เครื่องพิมพ์ยังคงรับงานพิมพ์

"OUT_OF_INK"
หมึกเครื่องพิมพ์หมด เครื่องพิมพ์ยังคงรับงานพิมพ์

"OUT_OF_PAPER"
เครื่องพิมพ์ไม่มีกระดาษ เครื่องพิมพ์ยังคงรับงานพิมพ์

"OUTPUT_FULL"
พื้นที่สำหรับกระดาษออกของเครื่องพิมพ์ (เช่น ถาด) เต็ม เครื่องพิมพ์ยังคงรับงานพิมพ์

"PAPER_JAM"
เครื่องพิมพ์มีกระดาษติด เครื่องพิมพ์ยังคงรับงานพิมพ์

"GENERIC_ISSUE"
ปัญหาทั่วไปบางอย่าง เครื่องพิมพ์ยังคงรับงานพิมพ์

"หยุด"
เครื่องพิมพ์หยุดทำงานและไม่พิมพ์ แต่ยังคงยอมรับงานพิมพ์

"UNREACHABLE"
เครื่องพิมพ์ไม่สามารถเข้าถึงได้และไม่ยอมรับงานพิมพ์

"EXPIRED_CERTIFICATE"
ใบรับรอง SSL หมดอายุแล้ว เครื่องพิมพ์ยอมรับงานแต่พิมพ์ไม่สำเร็จ

"พร้อมใช้งาน"
เครื่องพิมพ์พร้อมใช้งาน

SubmitJobRequest

พร็อพเพอร์ตี้

• งาน

  PrintJob

  งานพิมพ์ที่จะส่ง ประเภทเนื้อหาที่รองรับคือ "application/pdf" และ "image/png" Cloud Job Ticket ไม่ควรมีช่อง FitToPageTicketItem, PageRangeTicketItem และ ReverseOrderTicketItem เนื่องจากไม่เกี่ยวข้องกับการพิมพ์แบบเนทีฟ VendorTicketItem ไม่บังคับ ต้องมีฟิลด์อื่นๆ ทั้งหมด

SubmitJobResponse

พร็อพเพอร์ตี้

• jobId

  สตริง ไม่บังคับ

  รหัสของงานพิมพ์ที่สร้างขึ้น ซึ่งเป็นตัวระบุที่ไม่ซ้ำกันในงานพิมพ์ทั้งหมดในอุปกรณ์ หากสถานะไม่ใช่ OK ค่า jobId จะเป็น Null

• สถานะ

  SubmitJobStatus

  สถานะของคำขอ

SubmitJobStatus

สถานะของคำขอ submitJob

ค่าแจกแจง

"OK"
ระบบยอมรับคำของานพิมพ์ที่ส่งแล้ว

"USER_REJECTED"
ผู้ใช้ปฏิเสธคำของานพิมพ์ที่ส่ง

พร็อพเพอร์ตี้

MAX_GET_PRINTER_INFO_CALLS_PER_MINUTE

จำนวนครั้งสูงสุดที่เรียกใช้ getPrinterInfo ได้ต่อนาที

ค่า

20

MAX_SUBMIT_JOB_CALLS_PER_MINUTE

จำนวนครั้งสูงสุดที่เรียกใช้ submitJob ได้ต่อนาที

ค่า

40

เมธอด

cancelJob()

Promise

chrome.printing.cancelJob(
  jobId: string,
  callback?: function,
): Promise<void>

ยกเลิกงานที่ส่งก่อนหน้านี้

พารามิเตอร์

• jobId

  สตริง

  รหัสของงานพิมพ์ที่จะยกเลิก ซึ่งควรเป็นรหัสเดียวกับที่ได้รับใน SubmitJobResponse

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  () => void

การคืนสินค้า

• Promise<void>

  Chrome 100 ขึ้นไป

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getJobStatus()

Promise Chrome 135 ขึ้นไป

chrome.printing.getJobStatus(
  jobId: string,
  callback?: function,
): Promise<JobStatus>

แสดงสถานะของงานพิมพ์ การเรียกนี้จะดำเนินการไม่สำเร็จโดยมีข้อผิดพลาดขณะรันไทม์ หากไม่มีงานพิมพ์ที่มี jobId ที่ระบุ jobId: รหัสของงานพิมพ์ที่จะแสดงสถานะ ซึ่งควรเป็นรหัสเดียวกับที่ได้รับใน SubmitJobResponse

พารามิเตอร์

• jobId

  สตริง

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (status: JobStatus) => void

  • สถานะ

    JobStatus

การคืนสินค้า

• Promise<JobStatus>

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getPrinterInfo()

Promise

chrome.printing.getPrinterInfo(
  printerId: string,
  callback?: function,
): Promise<GetPrinterInfoResponse>

แสดงสถานะและความสามารถของเครื่องพิมพ์ในรูปแบบ CDD การเรียกนี้จะล้มเหลวโดยมีข้อผิดพลาดขณะรันไทม์หากไม่ได้ติดตั้งเครื่องพิมพ์ที่มีรหัสที่ระบุ

พารามิเตอร์

• printerId

  สตริง

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (response: GetPrinterInfoResponse) => void

  • การตอบกลับ

    GetPrinterInfoResponse

การคืนสินค้า

• Promise<GetPrinterInfoResponse>

  Chrome 100 ขึ้นไป

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getPrinters()

Promise

chrome.printing.getPrinters(
  callback?: function,
): Promise<Printer[]>

แสดงรายการเครื่องพิมพ์ที่พร้อมใช้งานในอุปกรณ์ ซึ่งรวมถึงเครื่องพิมพ์ที่เพิ่มด้วยตนเอง เครื่องพิมพ์ระดับองค์กร และเครื่องพิมพ์ที่ค้นพบ

พารามิเตอร์

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (printers: Printer[]) => void

  • เครื่องพิมพ์

    เครื่องพิมพ์[]

การคืนสินค้า

• Promise<Printer[]>

  Chrome 100 ขึ้นไป

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

submitJob()

Promise

chrome.printing.submitJob(
  request: SubmitJobRequest,
  callback?: function,
): Promise<SubmitJobResponse>

ส่งงานเพื่อพิมพ์ หากส่วนขยายไม่อยู่ในนโยบาย PrintingAPIExtensionsAllowlist ระบบจะแจ้งให้ผู้ใช้ยอมรับงานพิมพ์ ก่อน Chrome 120 ฟังก์ชันนี้ไม่ได้แสดงผลเป็น Promise

พารามิเตอร์

• ส่งคำขอ

  SubmitJobRequest

• callback

  function ไม่บังคับ

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (response: SubmitJobResponse) => void

  • การตอบกลับ

    SubmitJobResponse

การคืนสินค้า

• Promise<SubmitJobResponse>

  Chrome 100 ขึ้นไป

  ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onJobStatusChanged

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

เหตุการณ์เริ่มทำงานเมื่อสถานะของงานมีการเปลี่ยนแปลง ระบบจะเริ่มทำงานนี้สำหรับงานที่สร้างโดยส่วนขยายนี้เท่านั้น

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback จะมีลักษณะดังนี้

  (jobId: string, status: JobStatus) => void

  • jobId

    สตริง

  • สถานะ

    JobStatus