Method: customers.reports.enumeratePrintJobs

取得列印工作的清單。

HTTP 要求

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

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

路徑參數

參數
customer

string

必要欄位。客戶 ID 前置字串為「customers/」或「customers/my_customer」，可使用與提出要求的帳戶相關聯的客戶。

查詢參數

參數
printerOrgUnitId

string

印表機的機構單位 ID。如果指定了這個屬性，系統只會傳回從指定機構單位提交至印表機的列印工作。
pageSize

integer

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

string

從先前 reports.enumeratePrintJobs 呼叫收到的網頁權杖。提供此項目即可擷取後續網頁。如果省略此引數，系統會傳回第一頁的結果。

進行分頁時，提供至 reports.enumeratePrintJobs 的所有其他參數須與提供網頁權杖的呼叫相符。
filter

string

用於篩選結果的查詢字串，以 EBNF 語法中的 AND 分隔欄位。

注意：這個篩選器不支援 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

列印工作的專屬 ID。
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 ID。
printer

string

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

string

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

string

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

州

列印工作的狀態。

列舉
STATE_UNSPECIFIED 列印工作處於未指定的狀態。
PRINTED 已成功列印文件。
CANCELLED 列印工作已取消。
FAILED 列印工作失敗。

ColorMode

列印工作色彩模式。

列舉
COLOR_MODE_UNSPECIFIED 未指明
BLACK_AND_WHITE 黑白。
COLOR 顏色。

DuplexMode

列印工作雙面列印模式。

列舉
DUPLEX_MODE_UNSPECIFIED 未指明
ONE_SIDED 單面。
TWO_SIDED_LONG_EDGE 雙面翻頁 (長邊翻頁)。
TWO_SIDED_SHORT_EDGE 雙面翻頁 (短邊翻頁)。