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（含 0 和 100），如果未指定 pageSize 或为 0，则大小为 50。
pageToken

string

从之前的 printJobs.list 调用收到的页面令牌。提供此字段以检索后续页面。如果省略，则会返回结果的第一页。

进行分页时，提供给 printJobs.list 的所有其他参数必须与提供页面令牌的调用匹配。
filter

string

用于过滤结果的查询字符串，以及采用 EBNF 语法的分隔字段。

此过滤条件不支持“或”运算。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)（即“祖鲁时”）格式，分辨率为纳秒，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
completionTime

string (Timestamp format)

打印任务完成时间戳。

时间戳采用 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 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 彩色。

双面模式

打印双面模式。

枚举
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 注册。