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

列出列印工作。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。父項，這個父項擁有此列印工作集合。格式：customer/{customer-id}/chrome/printers/{printer-id} 印表機 ID 可以是 -，以列出所有印表機的列印工作。

查詢參數

參數
pageSize

integer

頁面中的列印工作數量 (從 0 到 100，含首尾)，如果未指定 pageSize 或零，則大小為 50。
pageToken

string

先前的 printJobs.list 呼叫收到的網頁憑證。請提供這個 ID 以擷取後續網頁。如果省略，系統會傳回第一頁的結果。

進行分頁時，提供給 printJobs.list 的所有其他參數都必須與提供網頁憑證的呼叫相符。
filter

string

用來篩選結果的查詢字串，「且」以 EBNF 語法分隔 AND 欄位。

這個篩選器不支援 OR 作業。completionTime 僅支援 >= 和 <= 比較子。只有 userEmail 和 orgUnitId 支援比較子。只有在 {printer-id} 為「-」時，才支援依 userEmail 或 orgUnitId 篩選。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)

列印工作建立時間戳記。

RFC3339 UTC 的「Zulu」格式的時間戳記，單位為奈秒解析度，最多可達 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
completionTime

string (Timestamp format)

列印工作完成時間戳記。

RFC3339 UTC 的「Zulu」格式的時間戳記，單位為奈秒解析度，最多可達 9 個小數位數。範例："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 ID。
printer

string

用於列印的印表機名稱。
userId

string

提交列印工作的使用者的專屬 Directory API ID。
userEmail

string

提交列印工作的使用者主要電子郵件地址。
deviceId

string

用於提交列印工作的裝置的專屬 Directory API ID。

狀態

列印工作的狀態。

列舉
STATE_UNSPECIFIED 列印工作未指定。
STATE_PRINTED 已成功列印文件。
STATE_CANCELED 列印工作已取消。
STATE_FAILED 列印工作失敗。

色彩模式

列印工作色彩模式。

列舉
COLOR_MODE_UNSPECIFIED 未指明
COLOR_MODE_BLACK_AND_WHITE 黑白。
COLOR_MODE_COLORED 彩色。

DuplexMode

列印工作雙重模式。

列舉
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

供應商提供的 ID，例如 iso_a3_297x420mm 或 na_index-3x5_3x5in。可能的值為 media IPP 屬性值。詳情請參閱 IPP 註冊資訊。