Method: customers.reports.enumeratePrintJobs

הורדה של רשימת עבודות הדפסה.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד 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

מזהה ייחודי ב-Directory API של המשתמש ששלח את משימת ההדפסה.

מדינה (State)

המצב של משימת ההדפסה.

טיפוסים בני מנייה (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 דו-צדדי, היפוך בצד הקצר