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

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],....

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