- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- ApplicationName
- กิจกรรม
- ResourceDetails
- AppliedLabel
- FieldValue
- TextListValue
- SelectionValue
- SelectionListValue
- UserValue
- UserListValue
- วันที่
- เหตุผล
- ลองใช้งาน
ดึงข้อมูลรายการกิจกรรมสําหรับบัญชีและแอปพลิเคชันของลูกค้าที่เฉพาะเจาะจง เช่น แอปพลิเคชันคอนโซลผู้ดูแลระบบหรือแอปพลิเคชัน Google ไดรฟ์ ดูข้อมูลเพิ่มเติมได้ที่คู่มือสำหรับรายงานกิจกรรมของผู้ดูแลระบบและ Google ไดรฟ์ ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ของรายงานกิจกรรมได้ที่คู่มืออ้างอิงพารามิเตอร์กิจกรรม
คำขอ HTTP
GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
userKey or all |
แสดงรหัสโปรไฟล์หรืออีเมลของผู้ใช้ที่ควรกรองข้อมูล อาจเป็น |
applicationName |
ชื่อแอปพลิเคชันที่จะดึงข้อมูลเหตุการณ์ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
actorIpAddress |
ที่อยู่ Internet Protocol (IP) ของโฮสต์ที่ดำเนินการ วิธีนี้เป็นวิธีเพิ่มเติมในการกรองข้อมูลสรุปของรายงานโดยใช้ที่อยู่ IP ของผู้ใช้ที่ระบบรายงานกิจกรรมอยู่ ที่อยู่ IP นี้อาจแสดงตำแหน่งจริงของผู้ใช้หรือไม่ก็ได้ เช่น ที่อยู่ IP อาจเป็นที่อยู่ของพร็อกซีเซิร์ฟเวอร์ของผู้ใช้หรือที่อยู่เครือข่ายส่วนตัวเสมือน (VPN) พารามิเตอร์นี้รองรับทั้งที่อยู่เวอร์ชัน IPv4 และ IPv6 |
customerId |
รหัสที่ไม่ซ้ำกันของลูกค้าที่จะดึงข้อมูล |
endTime |
ตั้งค่าช่วงสิ้นสุดของเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z ค่าเริ่มต้นคือเวลาโดยประมาณของคําขอ API รายงาน API มีแนวคิดพื้นฐานเกี่ยวกับเวลา 3 รายการ ได้แก่
endTime รายงานจะแสดงกิจกรรมทั้งหมดจาก startTime จนถึงปัจจุบันหรือ 180 วันล่าสุด หาก startTime อยู่ในช่วง 180 วันที่ผ่านมา
|
eventName |
ชื่อเหตุการณ์ที่ API ค้นหา |
filters |
สตริงการค้นหา พารามิเตอร์เหตุการณ์เหล่านี้เชื่อมโยงกับ ในตัวอย่างกิจกรรมในไดรฟ์ต่อไปนี้ รายการที่แสดงผลประกอบด้วยเหตุการณ์
การค้นหา
หมายเหตุ: API ไม่ยอมรับค่าหลายค่าของพารามิเตอร์เดียวกัน หากระบุพารามิเตอร์มากกว่า 1 ครั้งในคําขอ API ทาง API จะยอมรับเฉพาะค่าสุดท้ายของพารามิเตอร์นั้น นอกจากนี้ หากมีการระบุพารามิเตอร์ที่ไม่ถูกต้องในคําขอ API ทาง API จะละเว้นพารามิเตอร์นั้นและแสดงผลลัพธ์ที่เกี่ยวข้องกับพารามิเตอร์ที่ถูกต้องที่เหลือ หากไม่ได้ขอพารามิเตอร์ ระบบจะแสดงผลพารามิเตอร์ทั้งหมด |
maxResults |
กำหนดจำนวนระเบียนกิจกรรมที่แสดงในหน้าคำตอบแต่ละหน้า เช่น หากคําขอตั้งค่าเป็น |
orgUnitID |
รหัสของหน่วยขององค์กรที่จะรายงาน บันทึกกิจกรรมจะแสดงเฉพาะสำหรับผู้ใช้ในหน่วยขององค์กรที่ระบุเท่านั้น |
pageToken |
โทเค็นสำหรับระบุหน้าถัดไป รายงานที่มีหลายหน้าจะมีพร็อพเพอร์ตี้ |
startTime |
ตั้งค่าจุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z รายงานจะแสดงกิจกรรมทั้งหมดตั้งแต่ |
groupIdFilter |
รหัสกลุ่มที่คั่นด้วยคอมมา (มีการสร้างความสับสน) ซึ่งระบบจะกรองกิจกรรมของผู้ใช้ กล่าวคือ การตอบกลับจะมีกิจกรรมของผู้ใช้ที่อยู่ในรหัสกลุ่มอย่างน้อย 1 รหัสที่กล่าวถึงที่นี่เท่านั้น รูปแบบ: "id:abc123,id:xyz456" |
เนื้อความของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
เทมเพลต JSON สําหรับคอลเล็กชันกิจกรรม
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การแสดง JSON |
---|
{
"kind": string,
"etag": string,
"items": [
{
object ( |
ช่อง | |
---|---|
kind |
ประเภททรัพยากร API สำหรับรายงานกิจกรรม ค่าจะเป็น |
etag |
ETag ของทรัพยากร |
items[] |
ระเบียนกิจกรรมแต่ละรายการในการตอบกลับ |
nextPageToken |
โทเค็นสําหรับดึงข้อมูลหน้าถัดไปของรายงาน ระบบจะใช้ค่า |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/admin.reports.audit.readonly
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ApplicationName
Enum | |
---|---|
access_transparency |
รายงานกิจกรรมความโปร่งใสในการเข้าถึงของ Google Workspace จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรมความโปร่งใสในการเข้าถึงประเภทต่างๆ |
admin |
รายงานกิจกรรมของแอปพลิเคชันคอนโซลผู้ดูแลระบบจะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมของผู้ดูแลระบบประเภทต่างๆ |
calendar |
รายงานกิจกรรมของแอปพลิเคชัน Google ปฏิทินจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมในปฏิทินต่างๆ |
chat |
รายงานกิจกรรมใน Chat จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมใน Chat ต่างๆ |
drive |
รายงานกิจกรรมของแอปพลิเคชัน Google ไดรฟ์จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมใน Google ไดรฟ์ต่างๆ รายงานกิจกรรมในไดรฟ์มีให้บริการสำหรับลูกค้า Google Workspace Business และ Enterprise เท่านั้น |
gcp |
รายงานกิจกรรมของแอปพลิเคชัน Google Cloud Platform จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม GCP ต่างๆ |
gplus |
รายงานกิจกรรมของแอปพลิเคชัน Google+ จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม Google+ ต่างๆ |
groups |
รายงานกิจกรรมของแอปพลิเคชัน Google Groups จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมของ Groups ต่างๆ |
groups_enterprise |
รายงานกิจกรรมของ Enterprise Groups จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมของกลุ่ม Enterprise ต่างๆ |
jamboard |
รายงานกิจกรรมของ Jamboard จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมใน Jamboard ต่างๆ |
login |
รายงานกิจกรรมของแอปพลิเคชันการเข้าสู่ระบบจะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมการเข้าสู่ระบบประเภทต่างๆ |
meet |
รายงานกิจกรรมการตรวจสอบ Meet จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมการตรวจสอบ Meet ประเภทต่างๆ |
mobile |
รายงานกิจกรรมการตรวจสอบอุปกรณ์จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมการตรวจสอบอุปกรณ์ประเภทต่างๆ |
rules |
รายงานกิจกรรมของกฎจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมของกฎประเภทต่างๆ |
saml |
รายงานกิจกรรม SAML จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม SAML ประเภทต่างๆ |
token |
รายงานกิจกรรมของแอปพลิเคชันโทเค็นจะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมโทเค็นประเภทต่างๆ |
user_accounts |
รายงานกิจกรรมของแอปพลิเคชันบัญชีผู้ใช้จะแสดงข้อมูลบัญชีเกี่ยวกับเหตุการณ์กิจกรรมของบัญชีผู้ใช้ประเภทต่างๆ |
context_aware_access |
รายงานกิจกรรมการเข้าถึงแบบ Context-Aware จะแสดงข้อมูลเกี่ยวกับเหตุการณ์การปฏิเสธการเข้าถึงของผู้ใช้เนื่องจาก กฎการเข้าถึงแบบ Context-Aware |
chrome |
รายงานกิจกรรมใน Chrome จะแสดงข้อมูลเกี่ยวกับ เหตุการณ์ของเบราว์เซอร์ Chrome และ Chrome OS |
data_studio |
รายงานกิจกรรมของ Data Studio จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมของ Data Studio ประเภทต่างๆ |
keep |
รายงานกิจกรรมของแอปพลิเคชัน Keep จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมใน Google Keep ต่างๆ รายงานกิจกรรมใน Keep มีให้บริการสำหรับลูกค้า Google Workspace Business และ Enterprise เท่านั้น |
vault |
รายงานกิจกรรมของห้องนิรภัยจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมของห้องนิรภัยประเภทต่างๆ |
gemini_for_workspace |
รายงานกิจกรรมของแอป Gemini สำหรับ Workspace จะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรม Gemini ประเภทต่างๆ |
กิจกรรม
เทมเพลต JSON สําหรับทรัพยากรกิจกรรม
การแสดง JSON |
---|
{ "kind": string, "etag": string, "ownerDomain": string, "ipAddress": string, "events": [ { "type": string, "name": string, "parameters": [ { "messageValue": { "parameter": [ { object ( |
ช่อง | |
---|---|
kind |
ประเภททรัพยากร API สำหรับรายงานกิจกรรม ค่าจะเป็น |
etag |
ETag ของรายการ |
ownerDomain |
นี่คือโดเมนที่ได้รับผลกระทบจากเหตุการณ์ของรายงาน เช่น โดเมนของคอนโซลผู้ดูแลระบบหรือเจ้าของเอกสารของแอปพลิเคชันไดรฟ์ |
ipAddress |
ที่อยู่ IP ของผู้ใช้ที่ดำเนินการ ที่อยู่นี้คือที่อยู่ Internet Protocol (IP) ของผู้ใช้เมื่อเข้าสู่ระบบ Google Workspace ซึ่งอาจแสดงหรือไม่ได้แสดงตำแหน่งจริงของผู้ใช้ เช่น ที่อยู่ IP อาจเป็นที่อยู่ของพร็อกซีเซิร์ฟเวอร์ของผู้ใช้หรือที่อยู่เครือข่ายส่วนตัวเสมือน (VPN) API รองรับ IPv4 และ IPv6 |
events[] |
เหตุการณ์กิจกรรมในรายงาน |
events[].type |
ประเภทกิจกรรม บริการหรือฟีเจอร์ Google Workspace ที่ผู้ดูแลระบบเปลี่ยนแปลงจะระบุไว้ในพร็อพเพอร์ตี้ |
events[].name |
ชื่อเหตุการณ์ นี่คือชื่อที่เฉพาะเจาะจงของกิจกรรมที่ API รายงาน และ
ดูข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้ eventName ได้ในรายการชื่อเหตุการณ์สําหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
|
events[].parameters[] |
คู่ค่าพารามิเตอร์สําหรับแอปพลิเคชันต่างๆ ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ |
events[].parameters[].messageValue |
คู่ค่าพารามิเตอร์ที่ฝังอยู่ซึ่งเชื่อมโยงกับพารามิเตอร์นี้ ระบบจะแสดงผลประเภทค่าที่ซับซ้อนสำหรับพารามิเตอร์เป็นรายการค่าพารามิเตอร์ เช่น พารามิเตอร์ที่อยู่อาจมีค่าเป็น |
events[].parameters[].messageValue.parameter[] |
ค่าพารามิเตอร์ |
events[].parameters[].name |
ชื่อพารามิเตอร์ |
events[].parameters[].value |
ค่าสตริงของพารามิเตอร์ |
events[].parameters[].multiValue[] |
ค่าสตริงของพารามิเตอร์ |
events[].parameters[].intValue |
ค่าจำนวนเต็มของพารามิเตอร์ |
events[].parameters[].multiIntValue[] |
ค่าจำนวนเต็มของพารามิเตอร์ |
events[].parameters[].boolValue |
ค่าบูลีนของพารามิเตอร์ |
events[].parameters[].multiMessageValue[] |
activities.list ของออบเจ็กต์ |
events[].parameters[].multiMessageValue[].parameter[] |
ค่าพารามิเตอร์ |
events[].resourceIds[] |
รหัสทรัพยากรที่เชื่อมโยงกับเหตุการณ์ |
id |
ตัวระบุที่ไม่ซ้ำกันสำหรับระเบียนกิจกรรมแต่ละรายการ |
id.time |
เวลาเกิดกิจกรรม ข้อมูลนี้เป็นเวลา Unix Epoch เป็นวินาที |
id.uniqueQualifier |
ตัวคําจํากัดที่ไม่ซ้ำกันหากเหตุการณ์หลายรายการมีเวลาเดียวกัน |
id.applicationName |
ชื่อแอปพลิเคชันของเหตุการณ์ ดูค่าที่เป็นไปได้ได้ในรายการแอปพลิเคชันด้านบนใน |
id.customerId |
ตัวระบุที่ไม่ซ้ำสำหรับบัญชี Google Workspace |
actor |
ผู้ใช้ที่ดําเนินการ |
actor.profileId |
รหัสโปรไฟล์ Google Workspace ที่ไม่ซ้ำกันของผู้ดําเนินการ ค่านี้อาจไม่อยู่หากผู้ดําเนินการไม่ใช่ผู้ใช้ Google Workspace หรืออาจเป็นตัวเลข 105250506097979753968 ซึ่งทำหน้าที่เป็นรหัสตัวยึดตําแหน่ง |
actor.email |
อีเมลหลักของผู้ดำเนินการ อาจไม่มีหากไม่มีอีเมลที่เชื่อมโยงกับผู้ดำเนินการ |
actor.callerType |
ประเภทผู้ดําเนินการ |
actor.key |
แสดงเฉพาะเมื่อ |
actor.applicationInfo |
รายละเอียดของแอปพลิเคชันที่เป็นตัวดำเนินการของกิจกรรม |
actor.applicationInfo.oauthClientId |
รหัสไคลเอ็นต์ OAuth ของแอปพลิเคชันของบุคคลที่สามที่ใช้ดำเนินการ |
actor.applicationInfo.applicationName |
ชื่อแอปพลิเคชันที่ใช้ดำเนินการ |
actor.applicationInfo.impersonation |
แอปพลิเคชันแอบอ้างเป็นผู้ใช้หรือไม่ |
resourceDetails[] |
รายละเอียดของทรัพยากรที่มีการดำเนินการ |
ResourceDetails
รายละเอียดของทรัพยากรที่มีการดำเนินการ
การแสดง JSON |
---|
{
"id": string,
"title": string,
"type": string,
"appliedLabels": [
{
object ( |
ช่อง | |
---|---|
id |
ตัวระบุของทรัพยากร |
title |
ชื่อทรัพยากร เช่น ในกรณีของเอกสารในไดรฟ์ ฟิลด์นี้จะแสดงชื่อเอกสาร ในกรณีของอีเมล ข้อความนี้จะเป็นเรื่อง |
type |
ประเภททรัพยากร - เอกสาร อีเมล ข้อความแชท |
appliedLabels[] |
activities.list of labels applied on the resource |
relation |
กําหนดความสัมพันธ์ของทรัพยากรกับเหตุการณ์ |
AppliedLabel
รายละเอียดของป้ายกำกับที่ใช้กับทรัพยากร
การแสดง JSON |
---|
{ "id": string, "title": string, "fieldValues": [ { object ( |
ช่อง | |
---|---|
id |
ตัวระบุของป้ายกำกับ - เฉพาะรหัสป้ายกำกับ ไม่ใช่ชื่อทรัพยากร OnePlatform แบบเต็ม |
title |
ชื่อป้ายกำกับ |
fieldValues[] |
activities.list of fields which are part of the label and have been set by the user. หากป้ายกำกับมีช่องที่ผู้ใช้ไม่ได้ตั้งค่าไว้ ป้ายกำกับดังกล่าวจะไม่ปรากฏในรายการนี้ |
reason |
เหตุผลที่ใช้ป้ายกำกับกับทรัพยากร |
FieldValue
รายละเอียดค่าในฟิลด์ที่ผู้ใช้กําหนดสําหรับป้ายกำกับหนึ่งๆ
การแสดง JSON |
---|
{ "id": string, "displayName": string, "type": string, "reason": { object ( |
ช่อง | |
---|---|
id |
ตัวระบุของช่อง |
displayName |
ชื่อที่แสดงของฟิลด์ |
type |
ประเภทของช่อง |
reason |
เหตุผลที่ใช้ฟิลด์กับป้ายกำกับ |
ฟิลด์สหภาพ value จัดเก็บค่าที่เก็บไว้ในช่อง value ได้เพียงค่าใดค่าหนึ่งต่อไปนี้ |
|
unsetValue |
หากไม่ได้ตั้งค่าช่องนี้ ค่านี้จะเท่ากับ "จริง" |
longTextValue |
การตั้งค่าค่าข้อความแบบยาว |
textValue |
การตั้งค่าค่าข้อความ |
textListValue |
การตั้งค่าค่ารายการข้อความ |
selectionValue |
การตั้งค่าค่าการเลือกโดยเลือกค่าเดียวจากเมนูแบบเลื่อนลง |
selectionListValue |
การตั้งค่าค่ารายการตัวเลือกโดยเลือกหลายค่าจากเมนูแบบเลื่อนลง |
integerValue |
การตั้งค่าจำนวนเต็ม |
userValue |
การตั้งค่าค่าผู้ใช้โดยเลือกผู้ใช้รายเดียว |
userListValue |
การตั้งค่าค่ารายการผู้ใช้โดยเลือกผู้ใช้หลายราย |
dateValue |
การตั้งค่าค่าวันที่ |
TextListValue
การตั้งค่าค่ารายการข้อความ
การแสดง JSON |
---|
{ "values": [ string ] } |
ช่อง | |
---|---|
values[] |
activities.list of text values |
SelectionValue
การตั้งค่าค่าการเลือกโดยเลือกค่าเดียวจากเมนูแบบเลื่อนลง
การแสดง JSON |
---|
{ "id": string, "displayName": string, "badged": boolean } |
ช่อง | |
---|---|
id |
ตัวระบุของรายการที่เลือก |
displayName |
ชื่อที่แสดงของรายการที่เลือก |
badged |
รายการที่เลือกมีป้ายหรือไม่ |
SelectionListValue
การตั้งค่าค่ารายการตัวเลือกโดยเลือกหลายค่าจากเมนูแบบเลื่อนลง
การแสดง JSON |
---|
{
"values": [
{
object ( |
ช่อง | |
---|---|
values[] |
activities.list of selections |
UserValue
การตั้งค่าค่าผู้ใช้โดยเลือกผู้ใช้รายเดียว
การแสดง JSON |
---|
{ "email": string } |
ช่อง | |
---|---|
email |
อีเมลของผู้ใช้ |
UserListValue
การตั้งค่าค่ารายการผู้ใช้โดยเลือกผู้ใช้หลายราย
การแสดง JSON |
---|
{
"values": [
{
object ( |
ช่อง | |
---|---|
values[] |
activities.list of users |
วันที่
แสดงวันที่ในปฏิทินทั้งวันหรือบางส่วน เช่น วันเกิด ระบุเวลาของวันและเขตเวลาไว้ที่อื่นหรือไม่สําคัญ วันที่จะสัมพันธ์กับปฏิทินเกรโกเรียน ซึ่งอาจแสดงถึงสิ่งใดสิ่งหนึ่งต่อไปนี้
- วันที่แบบเต็มซึ่งมีค่าปี เดือน และวันที่ที่ไม่ใช่ 0
- เดือนและวันโดยไม่มีปี (เช่น วันครบรอบ)
- ปีเพียงอย่างเดียวที่มีเดือนเป็น 0 และวันเป็น 0
- ปีและเดือนที่มีวันเป็น 0 (เช่น วันที่หมดอายุของบัตรเครดิต)
ประเภทที่เกี่ยวข้อง
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
การแสดง JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
ช่อง | |
---|---|
year |
ปีของวันที่ ต้องอยู่ในช่วง 1 ถึง 9999 หรือ 0 เพื่อระบุวันที่โดยไม่มีปี |
month |
เดือนของปี ต้องมีค่าระหว่าง 1 ถึง 12 หรือ 0 เพื่อระบุปีโดยไม่มีเดือนและวัน |
day |
วันของเดือน ต้องมีค่าระหว่าง 1 ถึง 31 และใช้ได้กับปีและเดือน หรือ 0 เพื่อระบุปีเพียงอย่างเดียวหรือปีและเดือนที่วันไม่สําคัญ |
เหตุผล
เหตุผลที่ใช้ป้ายกำกับ/ช่อง
การแสดง JSON |
---|
{ "reasonType": string } |
ช่อง | |
---|---|
reasonType |
ประเภทของเหตุผล |