คู่มือนี้อธิบายวิธีใช้เมธอด update ในทรัพยากร Message ของ Google Chat API เพื่ออัปเดตข้อความหรือข้อความการ์ดในพื้นที่ทำงาน อัปเดตข้อความเพื่อเปลี่ยนแอตทริบิวต์ของข้อความ เช่น ข้อความที่แสดงหรือเนื้อหาของการ์ด นอกจากนี้ คุณยังสามารถใส่ข้อความไว้หน้าข้อความการ์ด หรือใส่การ์ดไว้หลังข้อความได้ด้วย
ใน Chat API ข้อความแชทจะแสดงด้วยทรัพยากร Message
แม้ว่าผู้ใช้ Chat จะส่งได้เฉพาะข้อความที่มีข้อความ แต่แอปใน Chat สามารถใช้ฟีเจอร์การรับส่งข้อความอื่นๆ ได้อีกมากมาย เช่น การแสดงอินเทอร์เฟซผู้ใช้แบบคงที่หรือแบบอินเทอร์แอกทีฟ การรวบรวมข้อมูลจากผู้ใช้ และการส่งข้อความแบบส่วนตัว ดูข้อมูลเพิ่มเติมเกี่ยวกับฟีเจอร์การรับส่งข้อความที่ใช้ได้กับ Chat API ได้ที่ภาพรวมข้อความ Google Chat
ข้อกำหนดเบื้องต้น
Node.js
- บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API ด้วยชื่อ ไอคอน และคำอธิบายสำหรับแอปใน Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ระบบคลาวด์ Node.js
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
Python
- บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API ด้วยชื่อ ไอคอน และคำอธิบายสำหรับแอปใน Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ระบบคลาวด์ Python
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
Java
- บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API ด้วยชื่อ ไอคอน และคำอธิบายสำหรับแอปใน Chat
- ติดตั้ง ไลบรารีของไคลเอ็นต์ระบบคลาวด์ Java
- สร้างข้อมูลเข้าสู่ระบบเพื่อเข้าถึงตามวิธีที่คุณต้องการตรวจสอบสิทธิ์ในคำขอ Google Chat API ดังนี้
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.jsonลงในไดเรกทอรีในเครื่อง - หากต้องการตรวจสอบสิทธิ์ในฐานะแอป Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ แล้วบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
credentials.json
- หากต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้ Chat ให้สร้างข้อมูลเข้าสู่ระบบรหัสไคลเอ็นต์ OAuth และบันทึกข้อมูลเข้าสู่ระบบเป็นไฟล์ JSON ชื่อ
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
Apps Script
- บัญชี Google Workspace แบบ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- ตั้งค่าสภาพแวดล้อมดังนี้
- สร้างโปรเจ็กต์ Google Cloud
- กำหนดค่าหน้าจอขอความยินยอม OAuth
- เปิดใช้และกำหนดค่า Google Chat API ด้วยชื่อ ไอคอน และคำอธิบายสำหรับแอปใน Chat
- สร้างโปรเจ็กต์ Apps Script แบบสแตนด์อโลน แล้วเปิดบริการ Chat ขั้นสูง
- ในคู่มือนี้ คุณต้องใช้การตรวจสอบสิทธิ์ผู้ใช้หรือแอป หากต้องการตรวจสอบสิทธิ์ในฐานะแอปใน Chat ให้สร้างข้อมูลเข้าสู่ระบบของบัญชีบริการ ดูขั้นตอนได้ที่หัวข้อตรวจสอบสิทธิ์และให้สิทธิ์ในฐานะแอป Google Chat
- เลือกขอบเขตการให้สิทธิ์โดยพิจารณาว่าคุณต้องการตรวจสอบสิทธิ์ในฐานะผู้ใช้หรือแอปใน Chat
อัปเดตข้อความในนามของผู้ใช้
เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะอัปเดตได้เฉพาะข้อความเท่านั้น
หากต้องการอัปเดตข้อความด้วยการตรวจสอบสิทธิ์ผู้ใช้ ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์
chat.messages - เรียกใช้เมธอด
UpdateMessage - ส่ง
messageเป็นอินสแตนซ์ของMessageพร้อมด้วยข้อมูลต่อไปนี้- ช่อง
nameที่ตั้งค่าเป็นข้อความที่จะอัปเดต ซึ่งรวมถึงรหัสพื้นที่ทำงานและรหัสข้อความ - ช่อง
textมีข้อความใหม่แล้ว
- ช่อง
- ส่ง
updateMaskพร้อมค่าtext
หากข้อความที่อัปเดตเป็นข้อความการ์ด ข้อความจะอยู่หน้าการ์ด (ซึ่งจะแสดงต่อไป)
วิธีอัปเดตข้อความหรือเพิ่มข้อความไว้หน้าข้อความการ์ดด้วยการตรวจสอบสิทธิ์ผู้ใช้มีดังนี้
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ค่าต่อไปนี้
SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณสามารถดูรหัสได้โดยเรียกใช้เมธอดListSpacesหรือจาก URL ของพื้นที่ทำงานMESSAGE_NAME: รหัสจากnameของข้อความ คุณสามารถรับรหัสจากเนื้อหาการตอบกลับที่แสดงผลหลังจากสร้างข้อความแบบอะซิงโครนัสด้วย Chat API หรือด้วยชื่อที่กำหนดเองที่กำหนดให้กับข้อความเมื่อสร้าง
Chat API จะแสดงผลอินสแตนซ์ของ Message ที่ให้รายละเอียดข้อความที่อัปเดต
อัปเดตข้อความในฐานะแอปใน Chat
เมื่อใช้การตรวจสอบสิทธิ์แอป คุณจะอัปเดตได้ทั้งข้อความและการ์ดของข้อความ
หากต้องการอัปเดตข้อความด้วยการตรวจสอบสิทธิ์ของแอป ให้ส่งข้อมูลต่อไปนี้ในคำขอ
- ระบุขอบเขตการให้สิทธิ์
chat.bot - เรียกใช้เมธอด
UpdateMessage - ส่ง
messageเป็นอินสแตนซ์ของMessageพร้อมด้วยข้อมูลต่อไปนี้- ช่อง
nameที่ตั้งค่าเป็นข้อความที่จะอัปเดต ซึ่งรวมถึงรหัสพื้นที่ทำงานและรหัสข้อความ - ช่อง
textที่ตั้งค่าด้วยข้อความใหม่หากจำเป็นต้องอัปเดต - ช่อง
cardsV2จะตั้งค่าด้วยบัตรใหม่หากจำเป็นต้องอัปเดต
- ช่อง
- ส่ง
updateMaskพร้อมรายการช่องที่จะอัปเดต เช่นtextและcardsV2
หากข้อความที่อัปเดตเป็นข้อความการ์ดและข้อความได้รับการอัปเดต ข้อความที่อัปเดตจะอยู่หน้าการ์ด (ซึ่งจะแสดงต่อไป) หากข้อความที่อัปเดตเป็นข้อความและมีการอัปเดตการ์ด ระบบจะเพิ่มการ์ดที่อัปเดตต่อท้ายข้อความ (ซึ่งจะยังคงแสดงอยู่)
วิธีอัปเดตข้อความและการ์ดของข้อความด้วยการตรวจสอบสิทธิ์แอปมีดังนี้
Node.js
Python
Java
Apps Script
หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ค่าต่อไปนี้
SPACE_NAME: รหัสจากnameของพื้นที่ทำงาน คุณสามารถดูรหัสได้โดยเรียกใช้เมธอดListSpacesหรือจาก URL ของพื้นที่ทำงานMESSAGE_NAME: รหัสจากnameของข้อความ คุณสามารถรับรหัสจากเนื้อหาการตอบกลับที่แสดงผลหลังจากสร้างข้อความแบบอะซิงโครนัสด้วย Chat API หรือด้วยชื่อที่กำหนดเองที่กำหนดให้กับข้อความเมื่อสร้าง
Chat API จะแสดงผลอินสแตนซ์ของ Message ที่ให้รายละเอียดข้อความที่อัปเดต
อัปเดตการ์ดแบบอะซิงโครนัส
คุณสามารถอัปเดตการ์ดในข้อความแบบไม่พร้อมกันได้โดยใช้เมธอด replaceCards ซึ่งจะเป็นประโยชน์สำหรับการอัปเดตเนื้อหาของการ์ดโดยไม่ต้องมีการโต้ตอบของผู้ใช้ เช่น การรีเฟรชตัวอย่างลิงก์หรือการอัปเดตสถานะของงาน
วิธีนี้ใช้ได้กับข้อความที่สร้างโดยแอป รวมถึงข้อความที่สร้างในนามของผู้ใช้
ดูรายละเอียดได้ที่หัวข้อสร้างและอัปเดตการ์ดแบบอินเทอร์แอกทีฟ