Method: admin.chrome.v1.customers.chrome.printers.printJobs.list

แสดงรายการงานพิมพ์

คำขอ HTTP

GET https://admin.googleapis.com/admin/chrome/v1/{parent=customers/*/chrome/printers/*}/printJobs

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ เจ้าของซึ่งเป็นเจ้าของงานพิมพ์นี้ รูปแบบ: customer/{customer-id}/chrome/printers/{printer-id} รหัสเครื่องพิมพ์อาจเป็น - เพื่อแสดงงานพิมพ์ในเครื่องพิมพ์ทั้งหมด

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

จํานวนงานพิมพ์ในหน้าตั้งแต่ 0 ถึง 100 หากไม่ได้ระบุ pageSize หรือ 0 ขนาดคือ 50
pageToken

string

โทเค็นของหน้าเว็บที่ได้รับจากการเรียก printJobs.list ก่อนหน้านี้ ระบุหน้านี้เพื่อเรียกข้อมูลหน้าต่อไป หากไม่ระบุ ระบบจะส่งผลการค้นหาหน้าแรก

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ printJobs.list ต้องตรงกับการเรียกที่ระบุโทเค็นหน้าเว็บ
filter

string

สตริงการค้นหาเพื่อกรองผลลัพธ์ ช่องที่คั่นด้วยเครื่องหมายจุลภาค และไวยากรณ์ EBNF

ตัวกรองนี้ไม่รองรับการดําเนินการ OR ระบบรองรับเพียง >= และ <= การเปรียบเทียบสําหรับ completionTime รองรับเฉพาะ = การเปรียบเทียบสําหรับ userEmail และ orgUnitId รองรับการกรองโดย userEmail หรือ orgUnitId เฉพาะเมื่อ {printer-id} เป็น '-' orgUnitId จะหมายถึงช่อง orgUnitId ของเครื่องพิมพ์ระดับบนสุด

ช่องตัวกรองที่รองรับ:

  • completionTime
  • orgUnitId
  • userEmail
orderBy

string

ช่องที่ใช้เรียงลําดับผลลัพธ์ หากไม่ได้ระบุ ผลการค้นหาจะเรียงลําดับตาม completionTime

ลําดับของช่องที่รองรับ

  • device
  • pageCount
  • creationTime
  • completionTime
  • status
  • printer
  • userEmail
  • title
  • color
  • duplex

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การตอบกลับที่มีรายการงานพิมพ์

การแสดง JSON 
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
ช่อง
printJobs[]

object (PrintJob)

รายการงานพิมพ์ที่ขอ
nextPageToken

string

โทเค็นซึ่งใช้ในคําขอที่ตามมาเพื่อเรียกหน้าถัดไปได้ หากเว้นช่องนี้ไว้ จะไม่มีหน้าต่อๆ ไป
totalSize

integer

จํานวนผลลัพธ์ทั้งหมด

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ข้อใดข้อหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/admin.chrome.printers
  • https://www.googleapis.com/auth/admin.chrome.printers.readonly

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวม OAuth 2.0

งานพิมพ์

PrintJob แสดงถึงคําขอพิมพ์เอกสารที่ส่งไปยังเครื่องพิมพ์

การแสดง JSON 
{
  "name": string,
  "title": string,
  "state": enum (State),
  "creationTime": string,
  "completionTime": string,
  "pageCount": integer,
  "color": enum (ColorMode),
  "duplex": enum (DuplexMode),
  "mediaSize": {
    object (MediaSize)
  },
  "copyCount": integer,
  "printerId": string,
  "printer": string,
  "userId": string,
  "userEmail": string,
  "deviceId": string
}
ช่อง
name

string

ชื่อทรัพยากรของงานพิมพ์ รูปแบบ: customers/{customer-id}/printers/{printer-id}/printJobs/{print-job-id}
title

string

ชื่อเอกสาร
state

enum (State)

สถานะสุดท้ายของงาน
creationTime

string (Timestamp format)

การประทับเวลาการสร้างงานพิมพ์

การประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและเป็นตัวเลขเศษส่วนไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
completionTime

string (Timestamp format)

การประทับเวลาการพิมพ์งานพิมพ์เสร็จสมบูรณ์

การประทับเวลาในรูปแบบ RFC3339 UTC "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและเป็นตัวเลขเศษส่วนไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
pageCount

integer

จํานวนหน้าในเอกสาร
color

enum (ColorMode)

โหมดสี
duplex

enum (DuplexMode)

โหมด Duplex
mediaSize

object (MediaSize)

ขนาดสื่อของงานพิมพ์
copyCount

integer

จํานวนสําเนา
printerId

string

รหัส API เครื่องพิมพ์
printer

string

ชื่อเครื่องพิมพ์ที่ใช้สําหรับพิมพ์
userId

string

รหัส Directory API ที่ไม่ซ้ํากันของผู้ใช้ที่ส่งงานพิมพ์
userEmail

string

อีเมลหลักของผู้ใช้ที่ส่งงานพิมพ์
deviceId

string

รหัส Directory API ที่ไม่ซ้ํากันของอุปกรณ์ที่ใช้ส่งงานพิมพ์

รัฐ

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

Enum
STATE_UNSPECIFIED งานพิมพ์อยู่ในสถานะไม่ระบุ
STATE_PRINTED พิมพ์เอกสารเรียบร้อยแล้ว
STATE_CANCELED งานพิมพ์ถูกยกเลิก
STATE_FAILED งานพิมพ์ล้มเหลว

โหมดสี

โหมดสีงานพิมพ์

Enum
COLOR_MODE_UNSPECIFIED ไม่ระบุ
COLOR_MODE_BLACK_AND_WHITE ขาวดํา
COLOR_MODE_COLORED เคลือบสีแล้ว

โหมด Duplex

โหมดพิมพ์งานพิมพ์

Enum
DUPLEX_MODE_UNSPECIFIED ไม่ระบุ
DUPLEX_MODE_ONE_SIDED พิมพ์ด้านเดียว
DUPLEX_MODE_TWO_SIDED_LONG_EDGE กลับด้าน 2 ด้านเหนือขอบด้านยาว
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE กลับด้าน 2 ด้านเหนือด้านสั้นๆ

ขนาดสื่อ

ขนาดสื่อของงานพิมพ์

การแสดง JSON 
{
  "width": integer,
  "height": integer,
  "vendorId": string
}
ช่อง
width

integer

ความกว้าง (เป็นไมโครเมตร)
height

integer

ความสูง (ไมโครเมตร)
vendorId

string

รหัสที่ผู้ให้บริการมีให้ เช่น iso_a3_297x420mm หรือ na_index-3x5_3x5in ค่าที่เป็นไปได้คือค่าของแอตทริบิวต์ IPP ของ media ดูข้อมูลเพิ่มเติมได้ที่การลงทะเบียน IPP