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)

打印任务创建时间戳。

时间戳采用 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 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 短边翻转，双面翻转。