واجهة برمجة التطبيقات 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
      },
     ...
     ]
    }
   ]
  }
 ]
}