Method: customers.reports.enumeratePrintJobs

Получите список заданий на печать.

HTTP-запрос

GET https://chromemanagement.googleapis.com/v1/{customer=customers/*}/reports:enumeratePrintJobs

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customer

string

Необходимый. Идентификатор клиента с префиксом «customers/» или «customers/my_customer» для использования клиента, связанного с учетной записью, делающей запрос.

Параметры запроса

Параметры
printerOrgUnitId

string

Идентификатор организационного подразделения для принтеров. Если указано, будут возвращены только задания на печать, отправленные на принтеры из указанного организационного подразделения.

pageSize

integer

Количество заданий печати на странице от 0 до 100 включительно, если pageSize не указан или равен нулю, размер будет равен 50.

pageToken

string

Токен страницы, полученный в результате предыдущего вызова reports.enumeratePrintJobs . Предоставьте это, чтобы получить следующую страницу. Если этот параметр опущен, будет возвращена первая страница результатов.

При разбиении на страницы все остальные параметры, предоставленные для reports.enumeratePrintJobs должны соответствовать вызову, который предоставил токен страницы.

filter

string

Строка запроса для фильтрации результатов, поля, разделенные И, в синтаксисе EBNF.

Примечание. Операции ИЛИ не поддерживаются в этом фильтре. Примечание. Для completeTime поддерживаются только компараторы >= и <=. Примечание. Only = поддерживается компаратор для userId и printerId .

Поддерживаемые поля фильтра:

  • полноевремя
  • идентификатор принтера
  • ID пользователя
orderBy

string

Поле, используемое для упорядочивания результатов. Если не указано, результаты будут упорядочены по убыванию поля completeTime .

Поддерживается порядок по полям:

  • заголовок
  • состояние
  • СоздатьВремя
  • полноевремя
  • ДокументПейджКаунт
  • цветной режим
  • дуплексный режим
  • принтер
  • электронная почта пользователя

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ, содержащий список заданий на печать.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Поля
printJobs[]

object ( PrintJob )

Список запрошенных заданий печати.

nextPageToken

string

Токен, который можно использовать в последующем запросе для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

totalSize

string ( int64 format)

Общее количество заданий печати, соответствующих запросу.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chrome.management.reports.readonly

ПечатьЗадание

Представляет запрос на печать документа, отправленного на принтер.

JSON-представление
{
  "id": string,
  "title": string,
  "state": enum (State),
  "createTime": string,
  "completeTime": string,
  "documentPageCount": integer,
  "colorMode": enum (ColorMode),
  "duplexMode": enum (DuplexMode),
  "copyCount": integer,
  "printerId": string,
  "printer": string,
  "userEmail": string,
  "userId": string
}
Поля
id

string

Уникальный идентификатор задания печати.

title

string

Название документа.

state

enum ( State )

Окончательное состояние работы.

createTime

string ( Timestamp format)

Отметка времени создания задания печати.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

completeTime

string ( Timestamp format)

Печать отметки времени завершения задания.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

documentPageCount

integer

Количество страниц в документе.

colorMode

enum ( ColorMode )

Цветовой режим.

duplexMode

enum ( DuplexMode )

Дуплексный режим.

copyCount

integer

Количество копий.

printerId

string

Идентификатор API принтера, используемого для печати.

printer

string

Имя принтера, используемого для печати.

userEmail

string

Основной адрес электронной почты пользователя, отправившего задание на печать.

userId

string

Уникальный идентификатор API каталога пользователя, отправившего задание на печать.

Состояние

Состояние задания печати.

Перечисления
STATE_UNSPECIFIED Задание печати находится в неопределенном состоянии.
PRINTED Документ успешно распечатан.
CANCELLED Задание печати было отменено.
FAILED Задание печати не выполнено.

Цветовой режим

Цветовой режим задания печати.

Перечисления
COLOR_MODE_UNSPECIFIED Неопределенные.
BLACK_AND_WHITE Черное и белое.
COLOR Цвет.

Дуплексный режим

Двусторонний режим печати задания.

Перечисления
DUPLEX_MODE_UNSPECIFIED Неопределенные.
ONE_SIDED Односторонний.
TWO_SIDED_LONG_EDGE Двусторонний переворот через длинный край.
TWO_SIDED_SHORT_EDGE Двусторонний переворот по короткому краю.
,

Получите список заданий на печать.

HTTP-запрос

GET https://chromemanagement.googleapis.com/v1/{customer=customers/*}/reports:enumeratePrintJobs

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customer

string

Необходимый. Идентификатор клиента с префиксом «customers/» или «customers/my_customer» для использования клиента, связанного с учетной записью, делающей запрос.

Параметры запроса

Параметры
printerOrgUnitId

string

Идентификатор организационного подразделения для принтеров. Если указано, будут возвращены только задания на печать, отправленные на принтеры из указанного организационного подразделения.

pageSize

integer

Количество заданий печати на странице от 0 до 100 включительно, если pageSize не указан или равен нулю, размер будет равен 50.

pageToken

string

Токен страницы, полученный в результате предыдущего вызова reports.enumeratePrintJobs . Предоставьте это, чтобы получить следующую страницу. Если этот параметр опущен, будет возвращена первая страница результатов.

При разбиении на страницы все остальные параметры, предоставленные для reports.enumeratePrintJobs должны соответствовать вызову, который предоставил токен страницы.

filter

string

Строка запроса для фильтрации результатов, поля, разделенные И, в синтаксисе EBNF.

Примечание. Операции ИЛИ не поддерживаются в этом фильтре. Примечание. Для completeTime поддерживаются только компараторы >= и <=. Примечание. Only = поддерживается компаратор для userId и printerId .

Поддерживаемые поля фильтра:

  • полноевремя
  • идентификатор принтера
  • ID пользователя
orderBy

string

Поле, используемое для упорядочивания результатов. Если не указано, результаты будут упорядочены по убыванию поля completeTime .

Поддерживается порядок по полям:

  • заголовок
  • состояние
  • СоздатьВремя
  • полноевремя
  • ДокументПейджКаунт
  • цветной режим
  • дуплексный режим
  • принтер
  • электронная почта пользователя

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ, содержащий список заданий на печать.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "printJobs": [
    {
      object (PrintJob)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Поля
printJobs[]

object ( PrintJob )

Список запрошенных заданий печати.

nextPageToken

string

Токен, который можно использовать в последующем запросе для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

totalSize

string ( int64 format)

Общее количество заданий печати, соответствующих запросу.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chrome.management.reports.readonly

ПечатьЗадание

Представляет запрос на печать документа, отправленного на принтер.

JSON-представление
{
  "id": string,
  "title": string,
  "state": enum (State),
  "createTime": string,
  "completeTime": string,
  "documentPageCount": integer,
  "colorMode": enum (ColorMode),
  "duplexMode": enum (DuplexMode),
  "copyCount": integer,
  "printerId": string,
  "printer": string,
  "userEmail": string,
  "userId": string
}
Поля
id

string

Уникальный идентификатор задания печати.

title

string

Название документа.

state

enum ( State )

Окончательное состояние работы.

createTime

string ( Timestamp format)

Отметка времени создания задания печати.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

completeTime

string ( Timestamp format)

Печать отметки времени завершения задания.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

documentPageCount

integer

Количество страниц в документе.

colorMode

enum ( ColorMode )

Цветовой режим.

duplexMode

enum ( DuplexMode )

Дуплексный режим.

copyCount

integer

Количество копий.

printerId

string

Идентификатор API принтера, используемого для печати.

printer

string

Имя принтера, используемого для печати.

userEmail

string

Основной адрес электронной почты пользователя, отправившего задание на печать.

userId

string

Уникальный идентификатор API каталога пользователя, отправившего задание на печать.

Состояние

Состояние задания печати.

Перечисления
STATE_UNSPECIFIED Задание печати находится в неопределенном состоянии.
PRINTED Документ успешно распечатан.
CANCELLED Задание печати было отменено.
FAILED Задание печати не выполнено.

Цветовой режим

Цветовой режим задания печати.

Перечисления
COLOR_MODE_UNSPECIFIED Неопределенные.
BLACK_AND_WHITE Черное и белое.
COLOR Цвет.

Дуплексный режим

Двусторонний режим печати задания.

Перечисления
DUPLEX_MODE_UNSPECIFIED Неопределенные.
ONE_SIDED Односторонний.
TWO_SIDED_LONG_EDGE Двусторонний переворот через длинный край.
TWO_SIDED_SHORT_EDGE Двусторонний переворот по короткому краю.