Method: userUsageReport.get

گزارشی را بازیابی می کند که مجموعه ای از ویژگی ها و آمار برای مجموعه ای از کاربران دارای حساب است. برای اطلاعات بیشتر، راهنمای گزارش استفاده از کاربر را ببینید. برای اطلاعات بیشتر در مورد پارامترهای گزارش کاربر، به راهنمای مرجع پارامترهای استفاده کاربران مراجعه کنید.

درخواست HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
userKey or all

string

نشان دهنده شناسه نمایه یا ایمیل کاربری است که داده ها باید فیلتر شوند. می‌تواند برای all اطلاعات باشد، یا userKey برای شناسه نمایه Google Workspace منحصربه‌فرد کاربر یا آدرس ایمیل اصلی او باشد. نباید کاربر حذف شده باشد. برای کاربر حذف شده، users.list در Directory API با showDeleted=true فراخوانی کنید، سپس از ID برگشتی به عنوان userKey استفاده کنید.

date

string

تاریخ استفاده را بر اساس UTC-8:00 (زمان استاندارد اقیانوس آرام) نشان می دهد. مهر زمانی در قالب ISO 8601 ، yyyy-mm-dd است.

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

مولفه های
customerId

string

شناسه منحصر به فرد مشتری برای بازیابی داده ها.

filters

string

رشته پرس و جو filters لیستی از پارامترهای رویداد برنامه است که با کاما از هم جدا شده است که در آن مقدار پارامتر توسط یک عملگر رابطه ای دستکاری می شود. رشته پرس و جو filters شامل نام برنامه ای است که استفاده از آن در گزارش برگردانده شده است. مقادیر برنامه برای گزارش استفاده کاربران شامل accounts ، docs و gmail است.

فیلترها به شکل [application name]:[parameter name][relational operator][parameter value],... هستند.

در این مثال، عملگر <> 'not barabartë' با URL در رشته درخواست درخواست (%3C%3E) کدگذاری شده است:

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

عملگرهای رابطه ای عبارتند از:

  • == - 'برابر'.
  • <> - 'برابر نیست'. رمزگذاری شده با URL است (%3C%3E).
  • < - 'کمتر از'. کدگذاری شده با URL (%3C) است.
  • <= - 'کمتر از یا مساوی'. این کد URL است (%3C=).
  • > - 'بیشتر از'. کدگذاری شده با URL (%3E) است.
  • >= - 'بزرگتر یا مساوی'. این با URL رمزگذاری شده است (%3E=).

maxResults

integer ( uint32 format)

تعیین می کند که چه تعداد رکورد فعالیت در هر صفحه پاسخ نشان داده می شود. به عنوان مثال، اگر درخواست maxResults=1 را تنظیم کند و گزارش دارای دو فعالیت باشد، گزارش دارای دو صفحه است. ویژگی nextPageToken پاسخ دارای نشانه صفحه دوم است.
رشته query maxResults اختیاری است.

orgUnitID

string

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

pageToken

string

نشانه برای تعیین صفحه بعدی. یک گزارش با چندین صفحه دارای ویژگی nextPageToken در پاسخ است. در درخواست بعدی خود برای دریافت صفحه بعدی گزارش، مقدار nextPageToken را در رشته پرس و جو pageToken وارد کنید.

parameters

string

رشته کوئری parameters فهرستی از پارامترهای رویداد جدا شده با کاما است که نتایج یک گزارش را اصلاح می کند. پارامتر با یک برنامه خاص مرتبط است. مقادیر برنامه برای گزارش استفاده از مشتریان شامل accounts ، app_maker ، apps_scripts ، calendar ، classroom ، cros ، docs ، gmail ، gplus ، device_management ، meet و sites می‌شود.
یک رشته جستجوی parameters به شکل CSV از app_name1:param_name1, app_name2:param_name2 است.

groupIdFilter

string

شناسه‌های گروه جدا شده با کاما (مبهم) که فعالیت‌های کاربر بر روی آنها فیلتر می‌شوند، یعنی پاسخ فقط شامل فعالیت‌هایی برای آن دسته از کاربرانی می‌شود که بخشی از حداقل یکی از شناسه‌های گروه ذکر شده در اینجا هستند. قالب: "id:abc123,id:xyz456"

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک نمونه از UsageReports است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.