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 או אפס, הגודל יהיה 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' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

completeTime

string (Timestamp format)

חותמת הזמן של השלמת משימת ההדפסה.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

המזהה הייחודי של המשתמש ב-Directory 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 היפוך דו-צדדי עם קצה קצר.