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
  • state
  • createTime
  • completeTime
  • documentPageCount
  • colorMode
  • duplexMode
  • printer
  • 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)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
completeTime

string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
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

โหมดดูเพล็กซ์ของงานพิมพ์

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