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

يمثل تاريخ حدوث الاستخدام، استنادًا إلى 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],....

في هذا المثال، يتم ترميز عامل التشغيل <> "لا يساوي" بعنوان 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.