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. מומלץ להשתמש באזור הזמן של החשבון שלכם. למידע נוסף על מחרוזות השאילתה ומאפייני התגובה של הבקשה, ראו הפניית API וחומר העזר בנושא פרמטרים של דוח שימוש של לקוחות.

בדוגמה הבאה מופיע דוח עם סך כל ההתחברויות בהצלחה לחשבון שלך ב-30 הימים האחרונים ורשימה של האפליקציות המורשות, עם מספר הרשאות המשתמש לכל בקשה, החל מ-3 במרץ 2013. 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
      },
     ...
     ]
    }
   ]
  }
 ]
}