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

Mostrar lista de trabajos de impresión

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. El elemento superior, que posee esta colección de trabajos de impresión Formato: customer/{customer-id}/chrome/printers/{printer-id} El ID de la impresora puede ser - para enumerar los trabajos de impresión de todas las impresoras.

Parámetros de consulta

Parámetros
pageSize

integer

La cantidad de trabajos de impresión en la página de 0 a 100 inclusive, si pageSize no se especifica o cero, el tamaño es 50.

pageToken

string

Un token de página recibido de una llamada printJobs.list anterior. Proporciona esto para recuperar la página siguiente. Si se omite, se muestra la primera página de resultados.

Cuando se pagina, todos los demás parámetros proporcionados a printJobs.list deben coincidir con la llamada que proporcionó el token de la página.

filter

string

String de consulta para filtrar los resultados y los campos separados por Y en sintaxis de EBNF.

Las operaciones OR no son compatibles con este filtro. Solo se admiten comparadores >= y <= para completionTime. Solo = el comparador es compatible con userEmail y orgUnitId. Solo se admite el filtrado por userEmail o orgUnitId cuando {printer-id} es "-". orgUnitId hace referencia al campo orgUnitId de la impresora superior.

Campos de filtro admitidos:

  • completionTime
  • orgUnitId
  • userEmail
orderBy

string

Campo usado para ordenar los resultados. Si no se especifica, los resultados se ordenan por completionTime.

Orden admitido por campos:

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Respuesta que contiene una lista de trabajos de impresión.

Representación JSON
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
printJobs[]

object (PrintJob)

Lista de trabajos de impresión solicitados.

nextPageToken

string

Un token, que se puede usar en una solicitud posterior para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

totalSize

integer

Número total de resultados.

Alcances de la autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

Trabajo de impresión

PrintJob representa una solicitud para imprimir un documento que se envió a una impresora.

Representación 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

El nombre de recurso del trabajo de impresión. Formato: customers/{customer-id}/printers/{printer-id}/printJobs/{print-job-id}

title

string

Es el título del documento.

state

enum (State)

El estado final del trabajo.

creationTime

string (Timestamp format)

Marca de tiempo de creación del trabajo de impresión.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

completionTime

string (Timestamp format)

Marca de tiempo de finalización del trabajo de impresión.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

pageCount

integer

Número de páginas del documento

color

enum (ColorMode)

Modo de color.

duplex

enum (DuplexMode)

Modo dúplex.

mediaSize

object (MediaSize)

Tamaño de medios del trabajo de impresión.

copyCount

integer

Cantidad de copias.

printerId

string

ID de API de la impresora

printer

string

Nombre de la impresora que se usa para imprimir.

userId

string

El ID de la API de Directory único del usuario que envió el trabajo de impresión.

userEmail

string

La dirección de correo electrónico principal del usuario que envió el trabajo de impresión.

deviceId

string

El ID único de la API de Directory del dispositivo que se usó para enviar el trabajo de impresión.

Estado

Estado del trabajo de impresión.

Enumeradores
STATE_UNSPECIFIED El trabajo de impresión se encuentra en un estado no especificado.
STATE_PRINTED El documento se imprimió correctamente.
STATE_CANCELED Se canceló el trabajo de impresión.
STATE_FAILED Error en el trabajo de impresión

Modo de color

Modo de color del trabajo de impresión.

Enumeradores
COLOR_MODE_UNSPECIFIED No se especifica.
COLOR_MODE_BLACK_AND_WHITE Blanco y negro.
COLOR_MODE_COLORED De color.

Modo doble

Modo de trabajo de doble impresión

Enumeradores
DUPLEX_MODE_UNSPECIFIED No se especifica.
DUPLEX_MODE_ONE_SIDED Un solo lado.
DUPLEX_MODE_TWO_SIDED_LONG_EDGE Levantamiento de dos lados sobre un borde largo.
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE Levantamiento de dos lados sobre un borde corto.

Tamaño de medios

Tamaño de medios del trabajo de impresión.

Representación JSON
{
  "width": integer,
  "height": integer,
  "vendorId": string
}
Campos
width

integer

Ancho (en micrómetros).

height

integer

Altura (en micrómetros).

vendorId

string

ID proporcionado por el proveedor, por ejemplo, iso_a3_297x420mm o na_index-3x5_3x5in. Los valores posibles son valores del atributo de IPP de media. Para obtener más información, consulta Registros de IPP.