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.

סדר נתמך לפי שדות:

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

completeTime

string (Timestamp format)

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

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

ארץ

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

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED הסטטוס של עבודת ההדפסה לא צוין.
PRINTED המסמך הודפס בהצלחה.
CANCELLED עבודת ההדפסה בוטלה.
FAILED משימת ההדפסה נכשלה.

ColorMode

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

טיפוסים בני מנייה (enums)
COLOR_MODE_UNSPECIFIED לא צוינה.
BLACK_AND_WHITE שחור ולבן.
COLOR צבע.

DuplexMode

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

טיפוסים בני מנייה (enums)
DUPLEX_MODE_UNSPECIFIED לא צוינה.
ONE_SIDED צד אחד.
TWO_SIDED_LONG_EDGE כיוון דו-צדדי על קצה ארוך
TWO_SIDED_SHORT_EDGE כיוון דו-צדדי על קצה קצר.