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

Liste os trabalhos de impressão.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai, que é proprietário dessa coleção de trabalhos de impressão. Formato: customer/{customer-id}/chrome/printers/{printer-id} o ID de impressora pode ser - para listar os trabalhos de impressão em todas as impressoras.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número de trabalhos de impressão na página de 0 a 100, se pageSize não for especificado ou zero, o tamanho será 50.

pageToken

string

Um token de página recebido de uma chamada printJobs.list anterior. Forneça isso para recuperar a página subsequente. Se omitido, a primeira página de resultados é retornada.

Ao paginar, todos os outros parâmetros fornecidos para printJobs.list precisam corresponder à chamada que forneceu o token da página.

filter

string

String de consulta para filtrar resultados e campos separados por AND na sintaxe EBNF.

As operações OR não são suportadas por este filtro. Somente os comparadores >= e <= são compatíveis com completionTime. Somente = comparador com suporte para userEmail e orgUnitId. A filtragem por userEmail ou orgUnitId só é compatível quando {printer-id} é "-". orgUnitId refere-se ao campo orgUnitId da impressora mãe.

Campos de filtro compatíveis:

  • completionTime
  • orgUnitId
  • userEmail
orderBy

string

Campo usado para ordenar os resultados. Se não for especificado, os resultados serão ordenados por completionTime.

Ordem aceita por campos:

  • device
  • pageCount
  • creationTime
  • completionTime
  • status
  • printer
  • userEmail
  • title
  • color
  • duplex

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Resposta contendo uma lista de trabalhos de impressão.

Representação JSON
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
printJobs[]

object (PrintJob)

Lista dos trabalhos de impressão solicitados.

nextPageToken

string

Um token, que pode ser usado em uma solicitação subsequente para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

totalSize

integer

Número total de resultados.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/admin.chrome.printers
  • https://www.googleapis.com/auth/admin.chrome.printers.readonly

Para mais informações, consulte a Visão geral do OAuth 2.0.

Trabalho de impressão

PrintJob representa uma solicitação para imprimir um documento que foi enviado para uma impressora.

Representação 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
}
Campos
name

string

O nome do recurso do trabalho de impressão. Formato: customers/{customer-id}/printers/{printer-id}/printJobs/{print-job-id}

title

string

É o título do documento.

state

enum (State)

O estado final do job.

creationTime

string (Timestamp format)

Carimbo de data/hora da criação do trabalho de impressão.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

completionTime

string (Timestamp format)

Carimbo de data/hora de conclusão do trabalho de impressão.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

pageCount

integer

Número de páginas no documento.

color

enum (ColorMode)

Modo de cor.

duplex

enum (DuplexMode)

Modo duplex.

mediaSize

object (MediaSize)

Tamanho da mídia do trabalho de impressão.

copyCount

integer

Número de cópias.

printerId

string

ID da API da impressora.

printer

string

Nome da impressora usada para impressão.

userId

string

O ID exclusivo da API Directory do usuário que enviou o trabalho de impressão.

userEmail

string

O endereço de e-mail principal do usuário que enviou o trabalho de impressão.

deviceId

string

O ID exclusivo da API Directory do dispositivo que foi usado para enviar o trabalho de impressão.

Estado

Estado do trabalho de impressão.

Enums
STATE_UNSPECIFIED O trabalho de impressão está em um estado não especificado.
STATE_PRINTED O documento foi impresso.
STATE_CANCELED O trabalho de impressão foi cancelado.
STATE_FAILED Falha no trabalho de impressão.

Modo de cor

Modo de cor do trabalho de impressão.

Enums
COLOR_MODE_UNSPECIFIED Não especificado.
COLOR_MODE_BLACK_AND_WHITE Preto e branco.
COLOR_MODE_COLORED Colorido.

Modo duplex

Imprimir o modo duplex do job.

Enums
DUPLEX_MODE_UNSPECIFIED Não especificado.
DUPLEX_MODE_ONE_SIDED Unilateral.
DUPLEX_MODE_TWO_SIDED_LONG_EDGE Virado de duas pontas.
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE Virado de duas pontas.

Tamanho da mídia

Tamanho da mídia do trabalho de impressão.

Representação JSON
{
  "width": integer,
  "height": integer,
  "vendorId": string
}
Campos
width

integer

Largura (em micrômetros).

height

integer

Altura (em micrômetros).

vendorId

string

ID fornecido pelo fornecedor, por exemplo, iso_a3_297x420mm ou na_index-3x5_3x5in. Os valores possíveis são valores do atributo IPP media. Para mais informações, consulte Registros de IPP.