Method: entityUsageReports.get

لاسترداد التقرير الذي يعد مجموعة من المواقع والإحصاءات للكيانات التي يستخدمها المستخدمون في الحساب. للمزيد من المعلومات، راجِع دليل تقرير استخدام الكيانات. للمزيد من المعلومات عن مَعلمات تقرير الكيانات، يُرجى الاطّلاع على الأدلّة المرجعية مَعلمات استخدام الكيانات.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
entityType

enum (EntityType)

يمثل نوع الكيان للتقرير.
entityKey or all

string

يمثل مفتاح الكائن الذي ستتم فلترة البيانات باستخدامه. وهو سلسلة يمكن أن تأخذ القيمة all للحصول على أحداث النشاط لجميع المستخدمين، أو أي قيمة أخرى لعنصر خاص بالتطبيق. للحصول على تفاصيل حول كيفية الحصول على entityKey لـ entityType محدّد، يُرجى الاطّلاع على الأدلّة المرجعية مَعلمات استخدام الكيانات.
date

string

يمثل تاريخ حدوث الاستخدام، استنادًا إلى التوقيت العالمي المنسق -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 equal to" بترميز عنوان 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

عمليات التعداد
gplus_communities عرض تقرير عن منتديات +Google.