Method: activities.watch

เริ่มรับการแจ้งเตือนสำหรับกิจกรรมในบัญชี ดูข้อมูลเพิ่มเติมได้ที่การรับ Push Notification

คำขอ HTTP

POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch

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

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

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

string

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

enum (ApplicationName)

ชื่อแอปพลิเคชันที่จะดึงข้อมูลเหตุการณ์

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

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

string

ที่อยู่ Internet Protocol (IP) ของโฮสต์ที่ดำเนินการ วิธีนี้เป็นวิธีเพิ่มเติมในการกรองข้อมูลสรุปของรายงานโดยใช้ที่อยู่ IP ของผู้ใช้ที่ระบบรายงานกิจกรรม ที่อยู่ IP นี้อาจแสดงหรือไม่แสดงสถานที่ตั้งทางกายภาพของผู้ใช้ เช่น ที่อยู่ IP อาจเป็นที่อยู่ของพร็อกซีเซิร์ฟเวอร์หรือที่อยู่เครือข่ายส่วนตัวเสมือน (VPN) ของผู้ใช้ได้ พารามิเตอร์นี้รองรับทั้งที่อยู่เวอร์ชัน IPv4 และ IPv6
customerId

string

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

string

ตั้งค่าการสิ้นสุดช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z ค่าเริ่มต้นคือเวลาโดยประมาณของคำขอ API รายงาน API มีแนวคิดพื้นฐานเกี่ยวกับเวลา 3 ประการ ดังนี้

  • วันที่คําขอรายงานของ API: เมื่อ API สร้างและดึงข้อมูลรายงาน
  • เวลาเริ่มต้นของรายงาน: จุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน startTime ต้องอยู่ก่อน endTime (หากระบุ) และเวลาปัจจุบันเมื่อส่งคำขอ มิเช่นนั้น API จะแสดงข้อผิดพลาด
  • เวลาสิ้นสุดของรายงาน: เวลาสิ้นสุดของช่วงเวลาที่แสดงในรายงาน เช่น ระยะเวลาของเหตุการณ์ที่สรุปในรายงานจะเริ่มในเดือนเมษายนและสิ้นสุดในเดือนพฤษภาคม คุณจะขอรายงานได้ในเดือนสิงหาคม
หากไม่ได้ระบุ endTime รายงานจะแสดงกิจกรรมทั้งหมดจาก startTime จนถึงปัจจุบันหรือ 180 วันล่าสุด หาก startTime อยู่ในช่วง 180 วันที่ผ่านมา
eventName

string

ชื่อเหตุการณ์ที่ API ค้นหา eventName แต่ละรายการเกี่ยวข้องกับบริการหรือฟีเจอร์ของ Google Workspace ที่เฉพาะเจาะจง ซึ่ง API จัดระเบียบเป็นประเภทเหตุการณ์ ตัวอย่างเช่น กิจกรรมใน Google ปฏิทินในรายงานของแอปพลิเคชันคอนโซลผู้ดูแลระบบ โครงสร้างการตั้งค่าปฏิทิน type มีกิจกรรม eventName ทั้งหมดของปฏิทินซึ่ง API รายงาน เมื่อผู้ดูแลระบบเปลี่ยนการตั้งค่าปฏิทิน API จะรายงานกิจกรรมนี้ในพารามิเตอร์การตั้งค่าปฏิทิน type และ eventName ดูข้อมูลเพิ่มเติมเกี่ยวกับสตริงการค้นหาและพารามิเตอร์ eventName ได้ที่รายการชื่อเหตุการณ์สําหรับแอปพลิเคชันต่างๆ ด้านบนใน applicationName
filters

string

สตริงการค้นหา filters คือรายการที่คั่นด้วยคอมมาซึ่งประกอบด้วยพารามิเตอร์เหตุการณ์ที่โอเปอเรเตอร์เชิงสัมพันธ์จัดการ พารามิเตอร์เหตุการณ์จะอยู่ในรูปแบบ {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

พารามิเตอร์เหตุการณ์เหล่านี้เชื่อมโยงกับ eventName ที่เฉพาะเจาะจง ระบบจะแสดงรายงานว่างหากพารามิเตอร์ของคําขอไม่ได้อยู่ใน eventName หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับช่อง eventName ที่ใช้ได้ของแต่ละแอปพลิเคชันและพารามิเตอร์ที่เชื่อมโยง โปรดไปที่ตาราง ApplicationName แล้วคลิกผ่านไปยังหน้าเหตุการณ์กิจกรรมในภาคผนวกสำหรับแอปพลิเคชันที่ต้องการ

ในตัวอย่างกิจกรรมในไดรฟ์ต่อไปนี้ รายการที่แสดงผลประกอบด้วยเหตุการณ์ edit ทั้งหมดที่ค่าพารามิเตอร์ doc_id ตรงกับเงื่อนไขที่โอเปอเรเตอร์เชิงสัมพันธ์กำหนด ในตัวอย่างนี้ คําขอจะแสดงผลเอกสารที่แก้ไขแล้วทั้งหมดซึ่งมีค่า doc_id เท่ากับ 12345 ในตัวอย่างที่ 2 รายงานจะแสดงเอกสารที่แก้ไขแล้วซึ่งมีค่า doc_id ไม่เท่ากับ 98765 โอเปอเรเตอร์ <> ที่เข้ารหัส URL ในสตริงการค้นหาของคําขอ (%3C%3E)

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

คำค้นหา filters รองรับโอเปอเรเตอร์เชิงสัมพันธ์ต่อไปนี้

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

หมายเหตุ: API ไม่ยอมรับค่าของพารามิเตอร์เดียวกันหลายค่า หากระบุพารามิเตอร์มากกว่า 1 ครั้งในคําขอ API ทาง API จะยอมรับเฉพาะค่าสุดท้ายของพารามิเตอร์นั้น นอกจากนี้ หากระบุพารามิเตอร์ที่ไม่ถูกต้องในคำขอ API API จะไม่สนใจพารามิเตอร์นั้นและแสดงผลการตอบกลับที่เกี่ยวข้องกับพารามิเตอร์ที่ถูกต้องที่เหลืออยู่ หากไม่ได้ขอพารามิเตอร์ ระบบจะแสดงผลพารามิเตอร์ทั้งหมด
maxResults

integer

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

string

Deprecated ช่องนี้เลิกใช้งานแล้วและไม่มีการรองรับอีกต่อไป

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

pageToken

string

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

string

ตั้งค่าจุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z รายงานจะแสดงกิจกรรมทั้งหมดตั้งแต่ startTime ถึง endTime startTime ต้องอยู่ก่อน endTime (หากระบุ) และเวลาปัจจุบันเมื่อส่งคำขอ มิเช่นนั้น API จะแสดงข้อผิดพลาด
groupIdFilter

string

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

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

เนื้อความของคำขอมีอินสแตนซ์ของ SubscriptionChannel

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

ช่องทางการแจ้งเตือนที่ใช้เพื่อคอยดูการเปลี่ยนแปลงทรัพยากร

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "id": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "payload": boolean,
  "params": {
    string: string,
    ...
  },
  "resourceId": string,
  "resourceUri": string,
  "kind": string
}
ช่อง
id

string

UUID หรือสตริงที่ไม่ซ้ำกันซึ่งระบุช่องนี้
token

string

สตริงที่กำหนดเองซึ่งส่งไปยังที่อยู่เป้าหมายพร้อมกับการแจ้งเตือนแต่ละรายการที่ส่งผ่านช่องทางนี้ ไม่บังคับ
expiration

string (int64 format)

วันที่และเวลาหมดอายุของช่องทางการแจ้งเตือนที่แสดงเป็นการประทับเวลา UNIX ในหน่วยมิลลิวินาที ไม่บังคับ
type

string

ประเภทของกลไกการนำส่งที่ใช้สำหรับแชแนลนี้ ค่าควรกำหนดไว้เป็น "web_hook"
address

string

อีเมลที่ใช้ส่งการแจ้งเตือนสำหรับช่องนี้
payload

boolean

ค่าบูลีนเพื่อระบุว่าต้องการเพย์โหลดหรือไม่ เพย์โหลดคือข้อมูลที่ส่งในเนื้อหาของข้อความ HTTP POST, PUT หรือ Patch และมีข้อมูลสำคัญเกี่ยวกับคำขอ ไม่บังคับ
params

map (key: string, value: string)

พารามิเตอร์เพิ่มเติมที่ควบคุมลักษณะการทํางานของช่องทางการส่ง ไม่บังคับ

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
resourceId

string

รหัสแบบทึบซึ่งระบุทรัพยากรที่รับชมในช่องนี้ ทำงานได้อย่างเสถียรใน API เวอร์ชันต่างๆ
resourceUri

string

ตัวระบุเฉพาะเวอร์ชันสำหรับทรัพยากรที่ดู
kind

string

ระบุว่านี่คือช่องทางการแจ้งเตือนที่ใช้เพื่อคอยดูการเปลี่ยนแปลงในทรัพยากร "api#channel"

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

ต้องใช้ขอบเขต 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 และ Google Workspace 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 เท่านั้น