Method: activities.watch

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

คำขอ HTTP

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

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

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

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

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 ในคำขอ ค่าเริ่มต้นคือ 1000
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

รหัสกลุ่มที่คั่นด้วยคอมมา (ปรับให้ยากต่อการอ่าน (Obfuscate)) ซึ่งมีการกรองกิจกรรมของผู้ใช้ กล่าวคือ การตอบกลับจะมีกิจกรรมเฉพาะผู้ใช้ที่เป็นส่วนหนึ่งของรหัสกลุ่มที่ระบุไว้ที่นี่อย่างน้อย 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

รายงานกิจกรรมกลุ่มองค์กรจะแสดงข้อมูลเกี่ยวกับเหตุการณ์กิจกรรมกลุ่มองค์กรต่างๆ
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 เท่านั้น