Method: customers.reports.enumeratePrintJobs

ดูรายการงานพิมพ์

คำขอ HTTP

GET https://chromemanagement.googleapis.com/v1/{customer=customers/*}/reports:enumeratePrintJobs

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

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

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

string

ต้องระบุ รหัสลูกค้าที่ขึ้นต้นด้วย "customers/" หรือ "customers/my_customer" จะใช้ลูกค้าที่เชื่อมโยงกับบัญชีที่ส่งคำขอ

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

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

string

รหัสหน่วยขององค์กรสำหรับเครื่องพิมพ์ หากระบุไว้ ระบบจะส่งคืนเฉพาะงานพิมพ์ที่ส่งไปยังเครื่องพิมพ์จากหน่วยขององค์กรที่ระบุเท่านั้น

pageSize

integer

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

pageToken

string

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

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

filter

string

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

หมายเหตุ: ตัวกรองนี้ไม่รองรับการดำเนินการ OR หมายเหตุ: ระบบรองรับตัวเปรียบเทียบ >= และ <= สำหรับ completeTime เท่านั้น หมายเหตุ: รองรับ = ตัวเปรียบเทียบสำหรับ userId และ printerId เท่านั้น

ฟิลด์ตัวกรองที่รองรับ:

  • completeTime
  • printerId
  • userId
orderBy

string

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

รองรับลำดับตามช่อง:

  • title
  • state
  • createTime
  • completeTime
  • documentPageCount
  • colorMode
  • duplexMode
  • เครื่องพิมพ์
  • userEmail

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

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

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

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

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

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

object (PrintJob)

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

nextPageToken

string

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

totalSize

string (int64 format)

จำนวนคำขอจับคู่งานพิมพ์ทั้งหมด

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

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

  • https://www.googleapis.com/auth/chrome.management.reports.readonly

PrintJob

หมายถึงคำขอให้พิมพ์เอกสารที่ส่งไปที่เครื่องพิมพ์

การแสดง JSON
{
  "id": string,
  "title": string,
  "state": enum (State),
  "createTime": string,
  "completeTime": string,
  "documentPageCount": integer,
  "colorMode": enum (ColorMode),
  "duplexMode": enum (DuplexMode),
  "copyCount": integer,
  "printerId": string,
  "printer": string,
  "userEmail": string,
  "userId": string
}
ช่อง
id

string

รหัสที่ไม่ซ้ำกันของงานพิมพ์

title

string

ชื่อเอกสาร

state

enum (State)

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

createTime

string (Timestamp format)

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

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

completeTime

string (Timestamp format)

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

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

documentPageCount

integer

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

colorMode

enum (ColorMode)

โหมดสี

duplexMode

enum (DuplexMode)

โหมดดูเพล็กซ์

copyCount

integer

จำนวนสำเนา

printerId

string

รหัส API ของเครื่องพิมพ์ที่ใช้สำหรับการพิมพ์

printer

string

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

userEmail

string

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

userId

string

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

รัฐ

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

Enum
STATE_UNSPECIFIED งานพิมพ์อยู่ในสถานะที่ไม่ระบุ
PRINTED พิมพ์เอกสารสำเร็จแล้ว
CANCELLED งานพิมพ์ถูกยกเลิก
FAILED งานพิมพ์ล้มเหลว

ColorMode

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

Enum
COLOR_MODE_UNSPECIFIED ไม่ระบุ
BLACK_AND_WHITE ขาวดำ
COLOR สี

DuplexMode

โหมดพิมพ์ 2 ด้านของงานพิมพ์

Enum
DUPLEX_MODE_UNSPECIFIED ไม่ระบุ
ONE_SIDED ด้านเดียว
TWO_SIDED_LONG_EDGE พลิก 2 ด้านเหนือขอบด้านยาว
TWO_SIDED_SHORT_EDGE พลิก 2 ด้านเหนือขอบด้านสั้น