หน้านี้ได้รับการแปลโดย Cloud Translation API

Method: activities.watch

คำขอ HTTP
พารามิเตอร์เส้นทาง
พารามิเตอร์การค้นหา
เนื้อความของคำขอ
เนื้อหาการตอบกลับ
- การแสดง JSON
ขอบเขตการให้สิทธิ์
ApplicationName

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

คำขอ 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)` ชื่อแอปพลิเคชันที่จะดึงเหตุการณ์

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` ฟิลด์นี้เลิกใช้งานแล้วและไม่รองรับอีกต่อไป รหัสของหน่วยขององค์กรที่จะรายงาน ระบบจะแสดงบันทึกกิจกรรมสำหรับผู้ใช้ที่อยู่ในหน่วยขององค์กรที่ระบุเท่านั้น ข้อมูลก่อนวันที่ 17 ธ.ค. 2018 จะไม่ปรากฏในผลลัพธ์ที่กรอง
`pageToken`	`string` โทเค็นเพื่อระบุหน้าถัดไป รายงานที่มีหลายหน้าจะมีพร็อพเพอร์ตี้ `nextPageToken` ในการตอบกลับ ในคำขอติดตามผลเพื่อรับรายงานหน้าถัดไป ให้ป้อนค่า `nextPageToken` ในสตริงการค้นหา `pageToken`
`startTime`	`string` กำหนดจุดเริ่มต้นของช่วงเวลาที่แสดงในรายงาน วันที่อยู่ในรูปแบบ RFC 3339 เช่น 2010-10-28T10:26:35.000Z รายงานจะแสดงกิจกรรมทั้งหมดตั้งแต่วันที่ `startTime` จนถึง `endTime` `startTime` ต้องอยู่ก่อน `endTime` (หากระบุ) และเวลาปัจจุบันเมื่อส่งคำขอ ไม่เช่นนั้น API จะแสดงข้อผิดพลาด
`groupIdFilter (deprecated)`	`string` `Deprecated` ฟิลด์นี้เลิกใช้งานแล้วและไม่รองรับอีกต่อไป รหัสกลุ่มที่คั่นด้วยคอมมา (ปิดบัง) ซึ่งกรองกิจกรรมของผู้ใช้ เช่น การตอบกลับจะมีกิจกรรมสําหรับผู้ใช้ที่เป็นส่วนหนึ่งของรหัสกลุ่มอย่างน้อย 1 รายการที่ระบุไว้ที่นี่เท่านั้น รูปแบบ: "id:abc123,id:xyz456" สำคัญ: หากต้องการกรองตามกลุ่ม คุณต้องเพิ่มกลุ่มดังกล่าวไปยังรายการที่อนุญาตสำหรับกลุ่มการกรองอย่างชัดเจน ดูข้อมูลเพิ่มเติมเกี่ยวกับการเพิ่มกลุ่มไปยังรายการที่อนุญาตของกลุ่มการกรองได้ที่กรองผลลัพธ์ตาม Google Group

เนื้อความของคำขอ

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

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

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

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

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

การแสดง 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