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

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

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

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

  • completeTime
  • printerId
  • userId
orderBy

string

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

ช่อง "จัดเรียงตาม" ที่รองรับ

  • title
  • รัฐ
  • 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 ด้านตามขอบด้านสั้น