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

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

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

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

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

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

Node.js

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

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

หากต้องการแสดงกิจกรรมในพื้นที่ทำงานจากพื้นที่ทำงานใน 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);
  }
}

await main();

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

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