Method: userUsageReport.get

ดึงข้อมูลรายงานซึ่งเป็นคอลเล็กชันพร็อพเพอร์ตี้และสถิติสําหรับกลุ่มผู้ใช้ที่มีบัญชี ดูข้อมูลเพิ่มเติมได้ที่คู่มือรายงานการใช้งานของผู้ใช้ ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ของรายงานผู้ใช้ได้ในคู่มืออ้างอิงพารามิเตอร์การใช้งานของผู้ใช้

คำขอ HTTP

GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
userKey

string

แสดงรหัสโปรไฟล์หรืออีเมลของผู้ใช้ที่ควรกรองข้อมูล อาจเป็น all สำหรับข้อมูลทั้งหมด หรือ userKey สำหรับรหัสโปรไฟล์ Google Workspace ที่ไม่ซ้ำของผู้ใช้หรืออีเมลหลัก ต้องไม่ใช่ผู้ใช้ที่ถูกลบ สําหรับผู้ใช้ที่ถูกลบ ให้เรียก users.list ใน Directory API ด้วย showDeleted=true จากนั้นใช้ ID ที่แสดงผลเป็น userKey
date

string

แสดงวันที่ที่มีการใช้งาน โดยอิงตาม UTC-8:00 (เวลามาตรฐานแปซิฟิก) การประทับเวลาอยู่ในรูปแบบ ISO 8601, yyyy-mm-dd

พารามิเตอร์การค้นหา

พารามิเตอร์
customerId

string

รหัสที่ไม่ซ้ำกันของลูกค้าที่จะดึงข้อมูล
filters

string

สตริงการค้นหา filters คือรายการพารามิเตอร์เหตุการณ์ของแอปพลิเคชันที่คั่นด้วยคอมมา โดยค่าของพารามิเตอร์จะได้รับการจัดการโดยโอเปอเรเตอร์เชิงสัมพันธ์ สตริงการค้นหา filters มีชื่อแอปพลิเคชันที่มีการใช้งานแสดงในรายงาน ค่าแอปพลิเคชันสำหรับรายงานการใช้งานของผู้ใช้ ได้แก่ accounts, docs และ gmail

ตัวกรองอยู่ในรูปแบบ [application name]:[parameter name][relational operator][parameter value],...

ในตัวอย่างนี้ โอเปอเรเตอร์ "ไม่เท่ากับ" <> มีการเข้ารหัส URL ในสตริงการค้นหาของคำขอ (%3C%3E) ดังนี้ 

GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

โอเปอเรเตอร์ที่เกี่ยวข้อง ได้แก่

  • == - "เท่ากับ"
  • <> - "ไม่เท่ากับ" แต่มีการเข้ารหัส URL (%3C%3E)
  • < - "น้อยกว่า" โดย URL ที่เข้ารหัส (%3C)
  • <= - "น้อยกว่าหรือเท่ากับ" แต่มีการเข้ารหัส URL (%3C=)
  • > - "มากกว่า" โดยใช้การเข้ารหัส URL (%3E)
  • >= - "มากกว่าหรือเท่ากับ" โดยใช้การเข้ารหัส URL (%3E=)
maxResults

integer (uint32 format)

กำหนดจำนวนระเบียนกิจกรรมที่แสดงในหน้าคำตอบแต่ละหน้า เช่น หากคําขอตั้งค่าเป็น maxResults=1 และรายงานมีกิจกรรม 2 รายการ รายงานจะมี 2 หน้า พร็อพเพอร์ตี้ nextPageToken ของการตอบกลับมีโทเค็นไปยังหน้าที่ 2
คุณจะระบุสตริงคำค้นหา maxResults หรือไม่ก็ได้
orgUnitID

string

รหัสของหน่วยขององค์กรที่จะรายงาน กิจกรรมของผู้ใช้จะแสดงเฉพาะสำหรับผู้ใช้ที่อยู่ในหน่วยขององค์กรที่ระบุเท่านั้น

pageToken

string

โทเค็นเพื่อระบุหน้าถัดไป รายงานที่มีหลายหน้าจะมีพร็อพเพอร์ตี้ nextPageToken ในการตอบกลับ ในคําขอติดตามเพื่อรับหน้าถัดไปของรายงาน ให้ป้อนค่า nextPageToken ในสตริงการค้นหา pageToken
parameters

string

สตริงการค้นหา parameters คือรายการพารามิเตอร์เหตุการณ์ที่คั่นด้วยคอมมาซึ่งจะปรับแต่งผลลัพธ์ของรายงาน พารามิเตอร์เชื่อมโยงกับแอปพลิเคชันหนึ่งๆ ค่าแอปพลิเคชันสำหรับรายงานการใช้งานของลูกค้า ได้แก่ accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet และ sites
สตริงการค้นหา parameters อยู่ในรูปแบบ CSV ของ app_name1:param_name1, app_name2:param_name2

groupIdFilter

string

รหัสกลุ่มที่คั่นด้วยคอมมา (มีการสร้างความสับสน) ซึ่งใช้กรองกิจกรรมของผู้ใช้ กล่าวคือ การตอบกลับจะมีกิจกรรมของผู้ใช้ที่อยู่ในรหัสกลุ่มอย่างน้อย 1 รหัสที่กล่าวถึงที่นี่เท่านั้น รูปแบบ: "id:abc123,id:xyz456"

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ UsageReports

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์