Method: entityUsageReports.get

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

คำขอ HTTP

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

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

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

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

enum (EntityType)

แสดงประเภทเอนทิตีของรายงาน
entityKey

string

แสดงคีย์ของออบเจ็กต์ที่จะใช้กรองข้อมูล และเป็นสตริงที่สามารถใช้ค่า all เพื่อรับเหตุการณ์กิจกรรมสำหรับผู้ใช้ทั้งหมด หรือค่าอื่นๆ สำหรับเอนทิตีเฉพาะแอป โปรดดูรายละเอียดเกี่ยวกับวิธีรับ entityKey สำหรับ entityType ที่เฉพาะเจาะจงในคู่มืออ้างอิงพารามิเตอร์การใช้งานเอนทิตี
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/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

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

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

integer (uint32 format)

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

string

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

string

สตริงการค้นหา parameters คือรายการพารามิเตอร์เหตุการณ์ที่คั่นด้วยคอมมาซึ่งจะปรับแต่งผลลัพธ์ของรายงาน พารามิเตอร์เชื่อมโยงกับแอปพลิเคชันหนึ่งๆ ค่าแอปพลิเคชันสำหรับรายงานการใช้งานเอนทิตีมีเพียง gplus เท่านั้น
สตริงการค้นหา parameter อยู่ในรูปแบบ CSV ของ [app_name1:param_name1], [app_name2:param_name2]...

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

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

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

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

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

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

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

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

EntityType

Enum
gplus_communities แสดงรายงานเกี่ยวกับชุมชน Google+