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 ปปปป-ดด-วว เราขอแนะนำให้คุณใช้เขตเวลาของบัญชีสำหรับการดำเนินการนี้ ดูข้อมูลเพิ่มเติมเกี่ยวกับสตริงการค้นหาและพร็อพเพอร์ตี้การตอบกลับของคำขอได้ที่เอกสารอ้างอิง API และข้อมูลอ้างอิงพารามิเตอร์รายงานการใช้งานของลูกค้า

ตัวอย่างต่อไปนี้จะเป็นรายงานที่มียอดรวมของการเข้าสู่ระบบที่สำเร็จทั้งหมดในบัญชีของคุณในช่วง 30 วันที่ผ่านมาและรายชื่อ ของแอปพลิเคชันที่ได้รับสิทธิ์พร้อมจำนวนการให้สิทธิ์ผู้ใช้ต่อแอปพลิเคชัน เริ่มตั้งแต่วันที่ 03-03-2013 maxResults สตริงการค้นหาแสดงให้เห็นว่ารายงานนี้แสดง 2 เหตุการณ์ต่อหน้ารายงาน:

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
      },
     ...
     ]
    }
   ]
  }
 ]
}