Method: customers.reports.enumeratePrintJobs

הצגת רשימה של משימות הדפסה.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

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