แสดงรายการกิจกรรมจากพื้นที่ใน Google Chat

คำแนะนำนี้จะอธิบายวิธีใช้เมธอด list() ในทรัพยากร SpaceEvent ของ Google Chat API เพื่อแสดงรายการการเปลี่ยนแปลงทรัพยากรในพื้นที่ทำงาน

แหล่งข้อมูลSpaceEventแสดงถึงการเปลี่ยนแปลงในพื้นที่ทำงานเป้าหมาย รวมถึงแหล่งข้อมูลย่อยของพื้นที่ทำงาน เช่น ข้อความ รีแอ็กชัน และการเป็นสมาชิก ดูข้อมูลเพิ่มเติมเกี่ยวกับรายการประเภทเหตุการณ์และเพย์โหลดเหตุการณ์ที่รองรับได้ที่ช่อง eventType และ payload ของเอกสารอ้างอิงทรัพยากร SpaceEvent

คุณสามารถแสดงกิจกรรมได้สูงสุด 28 วันก่อนถึงเวลาที่ขอ โดยเซิร์ฟเวอร์จะแสดงผลเหตุการณ์ที่มีเวอร์ชันล่าสุดของทรัพยากรที่ได้รับผลกระทบ ตัวอย่างเช่น หากคุณแสดงเหตุการณ์เกี่ยวกับสมาชิกใหม่ของพื้นที่ทำงาน เซิร์ฟเวอร์จะแสดงแหล่งข้อมูลMembershipที่มีรายละเอียดการเป็นสมาชิกล่าสุด หากมีการนำสมาชิกใหม่ออกในช่วงที่ขอ เพย์โหลดเหตุการณ์จะมีทรัพยากร Membership ว่างเปล่า

หากต้องการเรียกใช้เมธอดนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ หากต้องการแสดงรายการเหตุการณ์จากพื้นที่ทำงาน ผู้ใช้ที่ตรวจสอบสิทธิ์แล้วจะต้องเป็นสมาชิกของพื้นที่ทำงาน

ข้อกำหนดเบื้องต้น

Node.js

  • บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

แสดงรายการเหตุการณ์ใน Space

หากต้องการแสดงรายการเหตุการณ์ในพื้นที่ทำงานจากพื้นที่ใน Chat ให้ส่งข้อมูลต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์อย่างน้อย 1 รายการเพื่อรองรับเหตุการณ์แต่ละประเภทในคำขอ แนวทางปฏิบัติแนะนำคือเลือกขอบเขตที่จำกัดมากที่สุดซึ่งยังคงอนุญาตให้แอปทำงานได้ หากต้องการเลือกขอบเขต โปรดดูภาพรวมการตรวจสอบสิทธิ์และการให้สิทธิ์

  • เรียกใช้วิธี ListSpaceEvents() โดยส่ง filter ของประเภทเหตุการณ์ไปยังรายการ คุณต้องระบุประเภทเหตุการณ์อย่างน้อย 1 ประเภท และกรองตามวันที่ได้ด้วย ดูรายการประเภทเหตุการณ์ที่รองรับได้ที่เอกสารอ้างอิงสำหรับช่อง eventType ของทรัพยากร SpaceEvent

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

Node.js

chat/client-libraries/cloud/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly'
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter: 'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"'
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ SPACE_NAME ด้วยรหัสจาก name ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน

Chat API จะแสดงรายการรายการเหตุการณ์ของพื้นที่ทำงานแบบแบ่งหน้าเกี่ยวกับการเป็นสมาชิกและข้อความใหม่