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"
    }
   ]
  }
 ]
}