Reports API: تقرير استخدام الكيانات

يعرض تقرير استخدام الكيانات أنشطة خدمة Google Workspace المتعلّقة بالكيانات. التي يستخدمها مستخدمو حسابك. يمكن تخصيص هذه التقارير وفلترتها حسب استخدام معيّن. المعلومات. البيانات متاحة لآخر 30 يومًا.

لا يجوز استخدام تقرير استخدام الكيانات إلا لأغراض قانونية في بما يتوافق مع اتفاقية العملاء. تنطبق هذه التقارير أيضًا على Google Workspace وEducation

استرداد جميع أنشطة استخدام الكيانات

في الوقت الحالي، نوع الكيان الوحيد المتوافق مع واجهة برمجة التطبيقات هذه هو منتديات +Google. لاسترداد تقرير بجميع الأنشطة المتعلقة بعناصر التطبيقات في حسابك، استخدِم ما يلي: GET طلب HTTP وتضمين الرمز المميز للتفويض الموضح في مستندات التفويض بالنسبة سهولة القراءة، يتم تنسيق المثال التالي باستخدام إرجاع الأسطر:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

تشير القيمة date إلى تاريخ حدوث الاستخدام والطابع الزمني في التنسيق ISO 8601، yyyy-mm-dd ننصحك استخدم المنطقة الزمنية لحسابك لهذا الإجراء. لمزيد من المعلومات عن معلَمات سلسلة طلب البحث خصائص الاستجابة، يُرجى مراجعة واجهة برمجة التطبيقات المرجع: للحصول على معلومات عن معاملات تقرير استخدام الكيانات، اطّلِع على معلَمات استخدام الكيانات المرجع.

applicationParameters هي قائمة مفصولة بفواصل تضمّ المَعلمات التي تريد استردادها. يتم تنسيق كل مَعلمة على النحو التالي: application:parameter_name، على سبيل المثال: gplus:community_name ويتم توثيق المعلمات المتوفرة في معلَمات استخدام الكيانات المرجع. إذا لم يتم تحديد أي معلمات، سيتم عرضها جميعًا.

تمثّل السمة parameterFilters قائمة بالفلاتر المفصولة بفواصل لتطبيقها على النتائج. على كل تم تنسيق الفلتر على النحو التالي application:parameter_name[relational_operator]parameter_value على سبيل المثال، فلتر gplus:num_total_members>100 يؤدي إلى فلترة النتائج لاحتواء النتائج على نتائج فقط حيث تكون قيمة المعلَمة gplus:num_total_members أكبر من 100.

maxResults هو الحد الأقصى لعدد النتائج التي يمكن عرضها في عملية جلب واحدة. إذا كان الإجمالي عدد النتائج أكبر من ذلك، وسيتم اقتطاع الاستجابة سيتم تضمين nextPageToken (يمكنك الاطّلاع على مثال على استجابة JSON أدناه).

أمثلة

يحصل المثال التالي على تقرير يحتوي على جميع المعلمات لجميع كيانات gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

يحصل المثال التالي على تقرير يحتوي على المعلمة community_name لجميع كيانات gplus_communities.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

يحصل المثال التالي على تقرير عن community_name num_total_members لكل كيان gplus_communities، مع الفلترة حسب المنتديات التي تضم أكثر من 100 عضو. للحصول على مثال على استجابة واجهة برمجة التطبيقات، يمكنك الاطّلاع على مثال على استجابة JSON:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11
?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

{
 "kind": "reports#usageReports",
 "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
 "usageReports": [
 {
   "kind": "admin#reports#usageReport",
   "date": "2017-12-11",
   "entity": {
    "type": "OBJECT",
    "customerId": "C03az79cb",
    "objectType": "GPLUS_COMMUNITY",
    "objectId": "1234",
   },
   "parameters": [
    {
      "name": "gplus:community_name",
      "stringValue": "My Community"
    },
    {
     "name": "gplus:num_total_members",
     "intValue": 37
    },
    {
     "name": "gplus:num_7day_active_members",
     "intValue": 12
    },
    {
     "name": "gplus:num_30day_active_members",
     "intValue": 17
    },
   ]
  }
 ]
}

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": "PARTIAL_DATA_AVAILABLE"
      "message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
      "data": [
        {
          "key": "date"
          "value": "2017-12-11"
        }
      ]
    }
  ],
 "usageReports": [],
}