Method: admin.chrome.v1.customers.chrome.printers.printJobs.list

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

בקשת HTTP

GET https://admin.googleapis.com/admin/chrome/v1/{parent=customers/*/chrome/printers/*}/printJobs

כתובת ה-URL משתמשת בתחביר gRPC קידוד מחדש.

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

פרמטרים
parent

string

חובה. להורה יש אוסף של משימות הדפסה. פורמט: customer/{customer-id}/chrome/printers/{printer-id} מזהה המדפסת יכול להיות - כדי לרשום משימות הדפסה בכל המדפסות.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

מספר משימות ההדפסה בדף מ-0 עד 100 כולל, אם pageSize לא צוין או אפס, הגודל הוא 50.

pageToken

string

אסימון דף התקבל משיחת printJobs.list קודמת. צריך להזין אותו כדי לאחזר את הדף הבא. אם הוא לא מופיע, מוחזר הדף הראשון של התוצאות.

בעת עימוד, כל שאר הפרמטרים שמסופקים על ידי printJobs.list חייבים להתאים לשיחה שסיפקה את אסימון הדף.

filter

string

מחרוזת שאילתה לסינון התוצאות, ושדות מופרדים באמצעות תחביר ב-EBNF.

המסנן הזה לא תומך בפעולות OR. רק >= ו- <= משווים נתמכים עבור completionTime. רק = שותף השוואה נתמך לuserEmail ולorgUnitId. הסינון לפי userEmail או לפי orgUnitId נתמך רק כאשר {printer-id} הוא '-'. orgUnitId מתייחס לשדה orgUnitId של מדפסת האם.

שדות סינון נתמכים:

  • completionTime
  • orgUnitId
  • userEmail
orderBy

string

השדה המשמש לקביעת תוצאות. אם לא מציינים ערך, התוצאות מסודרות לפי completionTime.

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

  • device
  • pageCount
  • creationTime
  • completionTime
  • status
  • printer
  • userEmail
  • title
  • color
  • duplex

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם התגובה הצליחה, גוף התגובה מכיל נתונים במבנה הבא:

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

ייצוג JSON
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
שדות
printJobs[]

object (PrintJob)

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

nextPageToken

string

אסימון, שיכול לשמש בבקשה הבאה לאחזור הדף הבא. אם שדה זה יושמט, לא יהיו דפים נוספים.

totalSize

integer

מספר התוצאות הכולל.

היקפי הרשאה

יש צורך באחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/admin.chrome.printers
  • https://www.googleapis.com/auth/admin.chrome.printers.readonly

למידע נוסף, עיינו בסקירה כללית על OAuth 2.0.

משימת הדפסה

המונח PrintJob מייצג בקשה להדפסה של מסמך שנשלח למדפסת.

ייצוג JSON
{
  "name": string,
  "title": string,
  "state": enum (State),
  "creationTime": string,
  "completionTime": string,
  "pageCount": integer,
  "color": enum (ColorMode),
  "duplex": enum (DuplexMode),
  "mediaSize": {
    object (MediaSize)
  },
  "copyCount": integer,
  "printerId": string,
  "printer": string,
  "userId": string,
  "userEmail": string,
  "deviceId": string
}
שדות
name

string

שם המשאב של משימת ההדפסה. פורמט: customers/{customer-id}/printers/{printer-id}/printJobs/{print-job-id}

title

string

כותרת המסמך.

state

enum (State)

המצב הסופי של המשרה.

creationTime

string (Timestamp format)

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

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"

completionTime

string (Timestamp format)

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

חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z"

pageCount

integer

מספר הדפים במסמך.

color

enum (ColorMode)

מצב צבע.

duplex

enum (DuplexMode)

מצב דו-צדדי.

mediaSize

object (MediaSize)

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

copyCount

integer

מספר העותקים.

printerId

string

מזהה API של מדפסת.

printer

string

שם המדפסת המשמשת להדפסה.

userId

string

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

userEmail

string

כתובת האימייל הראשית של המשתמש ששלח את משימת ההדפסה.

deviceId

string

מזהה הספרייה הייחודי של ה-API של המכשיר שדרכו נשלחה משימת ההדפסה.

מדינה

הסטטוס של משימת ההדפסה.

Enums
STATE_UNSPECIFIED משימת ההדפסה במצב לא מוגדר.
STATE_PRINTED המסמך הודפס בהצלחה.
STATE_CANCELED משימת ההדפסה בוטלה.
STATE_FAILED משימת ההדפסה נכשלה.

מצב צבע

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

Enums
COLOR_MODE_UNSPECIFIED לא צוין.
COLOR_MODE_BLACK_AND_WHITE שחור ולבן.
COLOR_MODE_COLORED צבעונית.

מצב דו-צדדי

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

Enums
DUPLEX_MODE_UNSPECIFIED לא צוין.
DUPLEX_MODE_ONE_SIDED צד אחד.
DUPLEX_MODE_TWO_SIDED_LONG_EDGE היפוך דו-צדדי מעל קצה ארוך.
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE היפוך דו-צדדי מעל קצה קצר.

גודל מדיה

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

ייצוג JSON
{
  "width": integer,
  "height": integer,
  "vendorId": string
}
שדות
width

integer

רוחב (במיקרומטרים).

height

integer

גובה (במיקרומטרים).

vendorId

string

המזהה שסופק על ידי הספק — לדוגמה, iso_a3_297x420mm או na_index-3x5_3x5in. הערכים האפשריים הם הערכים של מאפיין IPP מסוג media. מידע נוסף זמין במאמר רישום IPP.