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 วันที่ผ่านมาและรายการแอปพลิเคชันที่ได้รับสิทธิ์ ซึ่งมีจํานวนการให้สิทธิ์ผู้ใช้ต่อแอปพลิเคชันตั้งแต่วันที่ 31-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
      },
     ...
     ]
    }
   ]
  }
 ]
}