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

Répertorier les tâches d'impression.

Requête HTTP :

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Parent, qui possède cette collection de tâches d'impression. Format: customer/{customer-id}/chrome/printers/{printer-id} L'ID d'imprimante peut être - pour répertorier les tâches d'impression sur toutes les imprimantes.

Paramètres de requête

Paramètres
pageSize

integer

Nombre de tâches d'impression sur la page compris entre 0 et 100 (si aucune valeur n'est spécifiée pour pageSize ou zéro, la taille est égale à 50).
pageToken

string

Jeton de page reçu d'un appel printJobs.list précédent. Fournissez-le pour récupérer la page suivante. En cas d'omission, la première page de résultats est renvoyée.

Lors de la pagination, tous les autres paramètres fournis à printJobs.list doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Chaîne de requête pour filtrer les résultats, champs séparés par une relation EBNF.

Les opérations OU ne sont pas compatibles avec ce filtre. Seuls les comparateurs >= et <= sont acceptés pour completionTime. Uniquement : comparateur compatible avec userEmail et orgUnitId. Le filtrage par userEmail ou orgUnitId n'est disponible que lorsque {printer-id} est '-'. orgUnitId fait référence au champ orgUnitId de l'imprimante parente.

Champs de filtre compatibles:

  • completionTime
  • orgUnitId
  • userEmail
orderBy

string

Champ utilisé pour classer les résultats. Si cette option n'est pas spécifiée, les résultats sont triés par completionTime.

Champs "Order by" acceptés:

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

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Réponse contenant une liste de tâches d'impression.

Représentation JSON 
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Champs
printJobs[]

object (PrintJob)

Liste des tâches d'impression demandées.
nextPageToken

string

Jeton pouvant être utilisé dans une requête ultérieure pour extraire la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
totalSize

integer

Nombre total de résultats.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

Tâche d'impression

PrintJob représente une requête d'impression d'un document envoyé à une imprimante.

Représentation 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
}
Champs
name

string

Nom de ressource de la tâche d'impression. Format : customers/{customer-id}/printers/{printer-id}/printJobs/{print-job-id}
title

string

Titre du document.
state

enum (State)

État final de la tâche.
creationTime

string (Timestamp format)

Horodatage de création de la tâche d'impression.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
completionTime

string (Timestamp format)

Horodatage de fin de la tâche d'impression.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
pageCount

integer

Nombre de pages du document.
color

enum (ColorMode)

Mode couleur.
duplex

enum (DuplexMode)

Mode Duplex.
mediaSize

object (MediaSize)

Taille du support de la tâche d'impression.
copyCount

integer

Nombre de copies.
printerId

string

ID de l'API Printer.
printer

string

Nom de l'imprimante utilisée pour l'impression.
userId

string

ID unique de l'API Directory de l'utilisateur ayant envoyé la tâche d'impression.
userEmail

string

Adresse e-mail principale de l'utilisateur ayant envoyé la tâche d'impression.
deviceId

string

ID unique de l'API Directory de l'appareil utilisé pour envoyer la tâche d'impression.

State

État de la tâche d'impression.

Enums
STATE_UNSPECIFIED La tâche d'impression n'est pas spécifiée.
STATE_PRINTED Le document a bien été imprimé.
STATE_CANCELED La tâche d'impression a été annulée.
STATE_FAILED Échec de la tâche d'impression.

Mode couleur

Mode de couleur de la tâche d'impression.

Enums
COLOR_MODE_UNSPECIFIED URL indéterminée.
COLOR_MODE_BLACK_AND_WHITE Noir et blanc
COLOR_MODE_COLORED Coloré.

Mode Duplex

Imprimer le mode recto verso.

Enums
DUPLEX_MODE_UNSPECIFIED URL indéterminée.
DUPLEX_MODE_ONE_SIDED Unilatérale.
DUPLEX_MODE_TWO_SIDED_LONG_EDGE Retournement des deux côtés sur un bord long.
DUPLEX_MODE_TWO_SIDED_SHORT_EDGE Retournement des deux côtés sur un bord court.

Taille du support

Taille du support de la tâche d'impression.

Représentation JSON 
{
  "width": integer,
  "height": integer,
  "vendorId": string
}
Champs
width

integer

Largeur (en micromètres)
height

integer

Hauteur (en micromètres)
vendorId

string

ID fourni par le fournisseur, par exemple iso_a3_297x420mm ou na_index-3x5_3x5in. Les valeurs possibles sont les valeurs de l'attribut IPP media. Pour en savoir plus, consultez Enregistrements IPP.