Method: customers.reports.enumeratePrintJobs

لیستی از کارهای چاپی را دریافت کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
customer

string

الزامی. شناسه مشتری با پیشوند "customers/" یا "customers/my_customer" برای استفاده از مشتری مرتبط با حساب کاربری که درخواست را ارسال می‌کند.

پارامترهای پرس و جو

پارامترها
printerOrgUnitId

string

شناسه واحد سازمانی برای چاپگرها. در صورت مشخص شدن، فقط کارهای چاپی ارسال شده به چاپگرها از واحد سازمانی مشخص شده بازگردانده می‌شوند.

pageSize

integer

تعداد کارهای چاپ در صفحه از ۰ تا ۱۰۰، اگر pageSize مشخص نشده باشد یا صفر باشد، اندازه ۵۰ خواهد بود.

pageToken

string

یک توکن صفحه که از فراخوانی قبلی reports.enumeratePrintJobs دریافت شده است. برای بازیابی صفحه بعدی، این توکن را ارائه دهید. در صورت حذف، صفحه اول نتایج بازگردانده می‌شود.

هنگام صفحه‌بندی، تمام پارامترهای دیگر ارائه شده به reports.enumeratePrintJobs باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشند.

filter

string

رشته پرس‌وجو برای فیلتر کردن نتایج، فیلدهای جدا شده با AND در سینتکس EBNF.

نکته: عملیات OR در این فیلتر پشتیبانی نمی‌شوند. نکته: فقط مقایسه‌کننده‌های >= و <= برای completeTime پشتیبانی می‌شوند. نکته: فقط مقایسه‌کننده = برای userId و printerId پشتیبانی می‌شود.

فیلدهای فیلتر پشتیبانی شده:

  • کامل کردن زمان
  • شناسه چاپگر
  • شناسه کاربری
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)

چاپ مهر زمانی ایجاد شغل.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

completeTime

string ( Timestamp format)

چاپ مهر زمان تکمیل کار.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

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 برگرداندن دو طرفه روی لبه کوتاه.