Reports API: דוח שימוש במשתמשים

דוח השימוש למשתמש מחזיר פרטי השימוש בשירות Google Workspace של משתמש מסוים בדומיין. אפשר להתאים אישית ולסנן את הדוחות לפי פרטי שימוש ספציפיים. ברירת המחדל ותקופת הזמן המקסימלית לכל דוח הן 450 הימים האחרונים.

ניתן להשתמש בדוחות שימוש אלה רק למטרות חוקיות, בהתאם להסכם הלקוח שלך. הדוחות האלה חלים על Google Workspace ועל Education.

אחזור כל פעילויות השימוש של המשתמשים

כדי לאחזר דוח של כל פעילויות המשתמש בחשבון, צריך להשתמש בבקשת ה-HTTP הבאה מסוג GET ולכלול את אסימון ההרשאה המתואר במסמכי התיעוד. כדי לשמור על קריאוּת, הדוגמה הבאה בפורמט של החזרות שורות:

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

הערך dates הוא התאריך שבו נעשה השימוש, וחותמת הזמן היא בפורמט ISO 8601 , yyyy-mm-dd. מידע נוסף על הפרמטרים של מחרוזת השאילתה ומאפייני התגובה זמינים בחומר העזר בנושא API. מידע על הפרמטרים של דוח השימוש למשתמש מופיע בחומר העזר בנושא פרמטרים של שימוש במשתמש.

בדוגמה הבאה מוצג דוח על כל פעילויות המשתמשים בחשבון.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?maxResults=2

בדוגמה הבאה מוצג דוח על כל פעילויות המשתמשים בחשבון לקוח ספציפי.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all
/dates/2013-03-03?customerId=C03az79cb

בדוגמה הבאה מופיע דוח על חותמות הזמן האחרונות של ההתחברות של המשתמשים בחשבון. דוגמה לתגובת API מופיעה בדוגמה לתגובת JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&maxResults=2

בדוגמה הבאה מופיע דוח על חותמות הזמן האחרונות להתחברות של המשתמשים בחשבון, לאחר סינון לפי משתמשים שהתחברו אחרי פרק זמן ספציפי. דוגמה לתגובת API מופיעה בדוגמה לתגובת JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time&filters=accounts:last_login_time
>2010-10-28T10:26:35.000Z"

בדוגמה הבאה מופיע דוח על חותמות הזמן האחרונות של ההתחברות ועל סטטוס ההשעיה של המשתמשים בחשבון. דוגמה לתגובת API מופיעה בדוגמה לתגובת JSON.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time,accounts:is_disabled"

אחזור פעילויות שימוש של משתמש ספציפי

כדי לאחזר דוח על פעילויות של משתמש מסוים בחשבון, צריך להשתמש בבקשת ה-HTTP הבאה מסוג GET ולכלול את אסימון ההרשאה המתואר במסמכי ההרשאות. כדי לשמור על קריאוּת, הדוגמה הבאה בפורמט של החזרות שורות.

GET https://admin.googleapis.com/admin/reports/v1/usage/users/userKey/dates/yyyy-mm-dd date
?parameters=application: user usage parameter,...
&filters=application: user usage parameter relational operator usage parameter's value,...
&maxResults=number of events listed on each page of the report

השדה userKey יכול להיות כתובת האימייל הראשית של המשתמש בדוח או כתובת Google Workspace profileId הייחודית של המשתמש. הערך dates הוא התאריך שבו נעשה השימוש, וחותמת הזמן היא בפורמט ISO 8601 , yyyy-mm-dd. מידע נוסף על הפרמטרים של מחרוזת השאילתה ומאפייני התגובה זמינים בחומר העזר בנושא API. מידע על הפרמטרים של דוח השימוש למשתמש מופיע בחומר העזר בנושא פרמטרים של שימוש במשתמש.

הדוגמה הבאה מקבלת את דוח השימוש של john@example.com.

https://admin.googleapis.com/admin/reports/v1/usage/users/john@example.com/dates/2013-03-03

תגובת JSON לדוגמה של דוח השימוש

תגובה מוצלחת תחזיר קוד סטטוס HTTP 200. יחד עם קוד הסטטוס, התשובה תחזיר דוח.

תגובת 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": "USER",
    "customerId": "C03az79cb",
    "userEmail": "liz@example.com",
    "profileId": "user's unique Google Workspace ID"
   },
   "parameters": [
    {
      "name": "accounts:is_disabled",
      "boolValue": false
     },
    {
     "name": "accounts:disabled_reason",
     "stringValue": "reason description"
    },
    {
     "name": "accounts:first_name",
     "stringValue": "Liz"
    },
    {
     "name": "accounts:is_2sv_enforced",
     "boolValue": false
    },
    {
     "name": "accounts:is_2sv_enrolled",
     "boolValue": false
    },
    {
     "name": "accounts:last_name",
     "stringValue": "Smith"
    },
    {
     "name": "accounts:creation_time",
     "datetimeValue": "2010-10-28T10:26:35.000Z"
    },
    {
     "name": "accounts:last_login_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    },
    {
     "name": "accounts:last_sso_time",
     "datetimeValue": "1970-01-01T00:00:00.000Z"
    }
   ]
  }
 ]
}