واجهة برمجة التطبيقات Reports API: تقرير استخدام العملاء

تقرير استخدام العملاء تجمع معلومات استخدام خدمة Google Workspace لجميع المستخدمين في نطاق كامل. يعرض تقرير استخدام المستخدم معلومات استخدام خدمة Google Workspace على مستوى حسابك. ويتم تنظيم معلومات الاستخدام هذه حسب نوع التطبيق الذي يتكون من مَعلمات خاصة بهذا التطبيق. الفترة الزمنية التلقائية والحد الأقصى لكل تقرير هي آخر 450 يومًا.

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

استرداد تقرير استخدام العميل

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

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/yyyy-mm-dd date
?parameters=app name: usage parameter,...
&customerId=the customer's ID
&maxResults=number of events listed on each page of the report

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

يحصل المثال التالي على تقرير بإجمالي جميع عمليات تسجيل الدخول الناجحة إلى حسابك في آخر 30 يومًا وقائمة من التطبيقات المعتمدة، مع عدد تفويضات المستخدم لكل تطبيق اعتبارًا من 2013-03-03. maxResults توضح سلسلة طلب البحث هذا التقرير الذي يعرض حدثين لكل صفحة تقرير: 

GET https://admin.googleapis.com/admin/reports/v1/usage/dates/2013-03-03
?parameters=accounts:num_30day_logins%2Caccounts:authorized_apps&maxResults=2

استجابة JSON لتقرير استخدام العميل

{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": warning machine-readable code,
      "message": warning human-readable message,
      "data": [
        {
          "key": key for key-value pair that gives detailed warning information,
          "value": value for key-value pair giving detailed warning information
        }
      ]
    }
  ],
 "nextPageToken": "N:NNN:NNN:N:C03az79cb",
 "usageReports": [
  {
   "kind": "usageReport",
   "date": "2013-03-03",
   "entity": {
    "type": "CUSTOMER",
    "customerId": "C03az79cb"
   },
   "parameters": [
    {
     "name": "accounts:num_1day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_30day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_7day_logins",
     "intValue": "1"
    },
    {
     "name": "accounts:num_disabled_accounts",
     "intValue": "5"
    },
    {
     "name": "accounts:authorized_apps",
     "msgValue": [
      {
       "client_id": "1234.apps.googleusercontent.com",
       "client_name": "www.example.com",
       "num_users": 2
      },
      {
       "client_id": "4567.apps.googleusercontent.com",
       "client_name": "Example",
       "num_users": 1
      },
     ...
     ]
    }
   ]
  }
 ]
}