คู่มือนี้อธิบายวิธีใช้เมธอด
get()
ในทรัพยากร SpaceEvent ของ Google Chat API เพื่อดูรายละเอียดเกี่ยวกับ
กิจกรรมจากพื้นที่ใน Chat
SpaceEventทรัพยากร
แสดงถึงการเปลี่ยนแปลงในพื้นที่ทำงานหรือทรัพยากรย่อยของพื้นที่ทำงาน เช่น ข้อความ
รีแอ็กชัน และการเป็นสมาชิก ดูข้อมูลเกี่ยวกับประเภทเหตุการณ์ที่รองรับได้ที่ฟิลด์
eventType ของเอกสารอ้างอิงSpaceEvent
คุณขอเหตุการณ์ได้สูงสุด 28 วันก่อนเวลาที่ขอ เหตุการณ์
มีทรัพยากรเวอร์ชันล่าสุดที่มีการเปลี่ยนแปลง เช่น หากคุณขอเหตุการณ์เกี่ยวกับข้อความใหม่ แต่ต่อมาข้อความได้รับการอัปเดต เซิร์ฟเวอร์จะแสดงผลMessageทรัพยากรที่อัปเดตแล้วในเพย์โหลดของเหตุการณ์
หากต้องการเรียกใช้เมธอดนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้ หากต้องการรับกิจกรรม ผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ต้องเป็นสมาชิกของพื้นที่ที่เกิดกิจกรรม
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมของคุณ ดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Node.js Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
Python
- บัญชี Google Workspace สำหรับธุรกิจหรือองค์กร ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมของคุณ ดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API พร้อมชื่อ ไอคอน และคำอธิบายสำหรับแอป Chat
- ติดตั้ง Python Cloud Client Library
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API
ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้
สร้างบัญชีบริการ
ข้อมูลเข้าสู่ระบบ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้
สร้างรหัสไคลเอ็นต์ OAuthและบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์ตามว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือ แอปใน Chat
ดูรายละเอียดเกี่ยวกับกิจกรรมในพื้นที่ (การตรวจสอบสิทธิ์ผู้ใช้)
หากต้องการดูรายละเอียดเกี่ยวกับกิจกรรมในพื้นที่ใน Google Chat ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์ที่รองรับประเภทเหตุการณ์ในคำขอ แนวทางปฏิบัติแนะนำคือเลือกขอบเขตที่จำกัดที่สุดซึ่งยังคงอนุญาตให้แอปทำงานได้
- เรียกใช้เมธอด
GetSpaceEvent()โดยส่งnameของกิจกรรมในพื้นที่ที่ต้องการรับ
ตัวอย่างต่อไปนี้จะรับเหตุการณ์ในพื้นที่ทำงาน
Node.js
ตัวอย่างโค้ด Node.js นี้ใช้ Chat RPC API
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่รายการต่อไปนี้
SCOPE_NAME: ขอบเขตการให้สิทธิ์ตามประเภทเหตุการณ์ เช่น หากคุณได้รับเหตุการณ์ในพื้นที่ทำงาน เกี่ยวกับการเป็นสมาชิกใหม่ ให้ใช้ขอบเขตchat.memberships.readonlyในรูปแบบhttps://www.googleapis.com/auth/chat.memberships.readonlyคุณรับประเภทเหตุการณ์ได้จากเมธอดListSpaceEvents()ดูวิธีใช้วิธีนี้ได้ที่ แสดงรายการกิจกรรมจากพื้นที่ทำงานSPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณรับรหัสได้โดยการเรียกใช้เมธอดListSpaces()หรือจาก URL ของพื้นที่ทำงานSPACE_EVENT_NAME: รหัสจากnameของกิจกรรมในพื้นที่ทำงาน คุณดูรหัสได้จากเมธอดListSpaceEvents()ดูวิธีใช้วิธีนี้ได้ที่ แสดงรายการกิจกรรมจากพื้นที่ทำงาน
Chat API จะแสดงอินสแตนซ์ของ
SpaceEvent
พร้อมรายละเอียดเกี่ยวกับเหตุการณ์
ดูรายละเอียดเกี่ยวกับกิจกรรมในพื้นที่ทำงาน (การตรวจสอบสิทธิ์แอป Chat)
การตรวจสอบสิทธิ์แอปต้องมีการอนุมัติจากผู้ดูแลระบบแบบครั้งเดียว
หากต้องการดูรายละเอียดเกี่ยวกับกิจกรรมในพื้นที่ทำงานจากพื้นที่ทำงานที่มีการตรวจสอบสิทธิ์แอป โดยใช้ Chat REST API ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์อย่างน้อย 1 รายการเพื่อรองรับเหตุการณ์แต่ละประเภทในคำขอ
แนวทางปฏิบัติแนะนำคือเลือกขอบเขตที่จำกัดที่สุดซึ่งยังคง
อนุญาตให้แอปทำงานได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับการเลือกขอบเขตได้ที่ภาพรวมการตรวจสอบสิทธิ์และการให้สิทธิ์
https://www.googleapis.com/auth/chat.app.membershipshttps://www.googleapis.com/auth/chat.app.memberships.readonlyhttps://www.googleapis.com/auth/chat.app.messages.readonlyhttps://www.googleapis.com/auth/chat.app.spaceshttps://www.googleapis.com/auth/chat.app.spaces.readonly
- เรียกใช้เมธอด
getในspaceEventsทรัพยากร - ส่ง
nameของพื้นที่ทำงานเพื่อรับรายละเอียดกิจกรรม
เขียนสคริปต์ที่เรียกใช้ Chat API
วิธีดูรายละเอียดเกี่ยวกับกิจกรรมในพื้นที่ทำงานด้วย การตรวจสอบสิทธิ์แอปและ Chat REST API มีดังนี้
Python
ตัวอย่างโค้ด Python นี้ใช้ Chat REST API
- สร้างไฟล์ชื่อ
chat_spaceevents_get_app.pyในไดเรกทอรีการทำงาน ใส่รหัสต่อไปนี้ใน
chat_spaceevents_get_app.pyfrom google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # Set authorization scopes based on the # event type. For example, if you are getting a space event # about a new membership, use the `chat.app.memberships` scope. # # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.app.memberships.readonly", "https://www.googleapis.com/auth/chat.app.messages.readonly", "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.app.spaces.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then lists space events from a specified space. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().spaceEvents().get( # The space to get event details from. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()ในโค้ด ให้แทนที่ค่าต่อไปนี้
SPACE_NAME: ชื่อพื้นที่ ซึ่งคุณดูได้จาก เมธอดspaces.listใน Chat API หรือจาก URL ของพื้นที่SPACE_EVENT_NAME: รหัสจากnameของกิจกรรมในพื้นที่ทำงาน คุณดูรหัสได้จากเมธอดListSpaceEvents()ดูวิธีใช้วิธีนี้ได้ที่ แสดงรายการกิจกรรมจากพื้นที่ทำงาน
ในไดเรกทอรีการทำงาน ให้สร้างและเรียกใช้ตัวอย่างโดยทำดังนี้
python3 chat_spaceevents_get_app.py
Chat API จะแสดงรายการ รายการเหตุการณ์ในพื้นที่ทำงานที่แบ่งหน้า เกี่ยวกับการเป็นสมาชิกและข้อความใหม่