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 ในคำขอหรือไม่ก็ได้ ค่าเริ่มต้นคือ 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

รายงานกิจกรรมกลุ่มองค์กรจะแสดงข้อมูลเกี่ยวกับเหตุการณ์ต่างๆ ของกิจกรรมกลุ่มองค์กร
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 และ ChromeOS
data_studio รายงานกิจกรรมของ Data Studio จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ของกิจกรรมประเภทต่างๆ ของ Data Studio
keep รายงานกิจกรรมของแอปพลิเคชัน Keep จะแสดงข้อมูลเกี่ยวกับเหตุการณ์ต่างๆ ของกิจกรรม Google Keep รายงานกิจกรรม Keep มีให้บริการสำหรับลูกค้า Google Workspace Business และ Enterprise เท่านั้น