Method: entityUsageReports.get

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

درخواست HTTP

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

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

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

مولفه های
entityType

enum ( EntityType )

نشان دهنده نوع نهاد برای گزارش است.

entityKey or all

string

نشان دهنده کلید شیء برای فیلتر کردن داده ها است. این رشته ای است که می تواند مقدار all برای دریافت رویدادهای فعالیت برای همه کاربران یا هر مقدار دیگری برای یک موجودیت خاص برنامه بگیرد. برای جزئیات در مورد نحوه بدست آوردن entityKey برای یک entityType خاص، به راهنمای مرجع پارامترهای استفاده از نهادها مراجعه کنید.

date

string

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

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

مولفه های
customerId

string

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

filters

string

رشته پرس و جو filters لیستی از پارامترهای رویداد برنامه است که با کاما از هم جدا شده است که در آن مقدار پارامتر توسط یک عملگر رابطه ای دستکاری می شود. رشته پرس و جو filters شامل نام برنامه ای است که استفاده از آن در گزارش برگردانده شده است. مقادیر برنامه برای گزارش استفاده از Entities شامل 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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

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

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

maxResults

integer ( uint32 format)

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

pageToken

string

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

parameters

string

رشته کوئری parameters فهرستی از پارامترهای رویداد جدا شده با کاما است که نتایج یک گزارش را اصلاح می کند. پارامتر با یک برنامه خاص مرتبط است. مقادیر برنامه برای گزارش استفاده از نهادها فقط gplus هستند.
یک رشته درخواست parameter به شکل CSV از [app_name1:param_name1], [app_name2:param_name2]... است.

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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

EntityType

Enums
gplus_communities گزارشی از انجمن‌های +Google را برمی‌گرداند.