گزارشی را بازیابی می کند که مجموعه ای از ویژگی ها و آمار موجودیت هایی است که توسط کاربران در حساب کاربری استفاده می شود. برای اطلاعات بیشتر، راهنمای گزارش استفاده از نهادها را ببینید. برای اطلاعات بیشتر در مورد پارامترهای گزارش نهادها، به راهنمای مرجع پارامترهای استفاده از نهادها مراجعه کنید.
درخواست HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}
نشان دهنده کلید شیء برای فیلتر کردن داده ها است. این رشته ای است که می تواند مقدار 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=).
فیلترها فقط برای پارامترهای عددی قابل اعمال هستند.
تعیین می کند که چه تعداد رکورد فعالیت در هر صفحه پاسخ نشان داده می شود. به عنوان مثال، اگر درخواست <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 است.
تاریخ آخرین بهروزرسانی 2024-08-26 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین بهروزرسانی 2024-08-26 بهوقت ساعت هماهنگ جهانی."],[[["Retrieves properties and statistics for entities used within a Google Workspace account."],["Allows filtering by entity type, entity key, and date."],["Data can be refined using query parameters like `customerId`, `filters`, and `parameters`."],["Requires the `https://www.googleapis.com/auth/admin.reports.usage.readonly` authorization scope."],["Currently supports Google+ communities as an entity type."]]],[]]
