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)

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

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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

โหมดการพิมพ์งานแบบ 2 ด้าน

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