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

印刷ジョブを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。この印刷ジョブのコレクションを所有している親。形式: customer/{customer-id}/chrome/printers/{printer-id} プリンタ ID は - にして、すべてのプリンタで印刷ジョブの一覧を表示できます。

クエリ パラメータ

パラメータ
pageSize

integer

ページの印刷ジョブの数。0 ～ 100 で指定します。pageSize が指定されていない場合、またはゼロの場合、サイズは 50 です。
pageToken

string

前回の printJobs.list 呼び出しから受け取ったページトークン。次のページを取得するために指定します。省略した場合、結果の最初のページが返されます。

ページ分割を行う場合、printJobs.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter

string

結果をフィルタするクエリ文字列。EBNF 構文の AND 区切りフィールド。

OR 演算はこのフィルタでサポートされていません。completionTime でサポートされるのは >= と <= のコンパレータのみです。userEmail と orgUnitId でサポートされるコンパレータのみ。userEmail または orgUnitId によるフィルタは、{printer-id} が「-」の場合にのみサポートされます。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

印刷ジョブのステータス。

列挙型
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 登録をご覧ください。