הצגת רשימת משימות הדפסה.
בקשת HTTP
GET https://admin.googleapis.com/admin/chrome/v1/{parent=customers/*/chrome/printers/*}/printJobs
כתובת ה-URL משתמשת בתחביר gRPC קידוד מחדש.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. להורה יש אוסף של משימות הדפסה. פורמט: |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
מספר משימות ההדפסה בדף מ-0 עד 100 כולל, אם |
pageToken |
אסימון דף התקבל משיחת בעת עימוד, כל שאר הפרמטרים שמסופקים על ידי |
filter |
מחרוזת שאילתה לסינון התוצאות, ושדות מופרדים באמצעות תחביר ב-EBNF. המסנן הזה לא תומך בפעולות OR. רק >= ו- <= משווים נתמכים עבור שדות סינון נתמכים:
|
orderBy |
השדה המשמש לקביעת תוצאות. אם לא מציינים ערך, התוצאות מסודרות לפי סדר נתמך לפי שדות:
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם התגובה הצליחה, גוף התגובה מכיל נתונים במבנה הבא:
תגובה שמכילה רשימה של משימות הדפסה.
ייצוג JSON |
---|
{
"printJobs": [
{
object ( |
שדות | |
---|---|
printJobs[] |
רשימה של משימות ההדפסה המבוקשות. |
nextPageToken |
אסימון, שיכול לשמש בבקשה הבאה לאחזור הדף הבא. אם שדה זה יושמט, לא יהיו דפים נוספים. |
totalSize |
מספר התוצאות הכולל. |
היקפי הרשאה
יש צורך באחד מהיקפי ההרשאות הבאים של 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 ( |
שדות | |
---|---|
name |
שם המשאב של משימת ההדפסה. פורמט: |
title |
כותרת המסמך. |
state |
המצב הסופי של המשרה. |
creationTime |
חותמת זמן של יצירת משימת הדפסה. חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: |
completionTime |
חותמת זמן של השלמת משימת ההדפסה. חותמת זמן בפורמט "Zulu" של RFC3339 UTC, עם רזולוציית ננו-שניות ועד תשע ספרות עשרוניות. דוגמאות: |
pageCount |
מספר הדפים במסמך. |
color |
מצב צבע. |
duplex |
מצב דו-צדדי. |
mediaSize |
גודל המדיה של משימת ההדפסה. |
copyCount |
מספר העותקים. |
printerId |
מזהה API של מדפסת. |
printer |
שם המדפסת המשמשת להדפסה. |
userId |
המזהה הייחודי של Directory API של המשתמש ששלח את משימת ההדפסה. |
userEmail |
כתובת האימייל הראשית של המשתמש ששלח את משימת ההדפסה. |
deviceId |
מזהה הספרייה הייחודי של ה-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 |
רוחב (במיקרומטרים). |
height |
גובה (במיקרומטרים). |
vendorId |
המזהה שסופק על ידי הספק — לדוגמה, |