ส่วนนี้จะอธิบายวิธีที่แอป Google Chat เรียกใช้ Chat API ซึ่งช่วยให้แอป Chat ทำสิ่งต่างๆ ได้ เช่น สร้างพื้นที่ทำงาน เพิ่มผู้คน และโพสต์ข้อความโดยไม่ได้รับแจ้งจากเหตุการณ์การโต้ตอบของแอป Chat
การตรวจสอบสิทธิ์
การเรียกใช้ Chat API แบบไม่พร้อมกันต้องมีการตรวจสอบสิทธิ์ เมธอดของ Chat API แต่ละรูปแบบต้องมี การตรวจสอบสิทธิ์ผู้ใช้ (เพื่อดำเนินการหรือเข้าถึงข้อมูลในนามของผู้ใช้) หรือ การตรวจสอบสิทธิ์แอป (เพื่อดำเนินการหรือเข้าถึงข้อมูลแบบแอป Chat) โดยบางวิธีรองรับทั้งการตรวจสอบสิทธิ์ผู้ใช้และการตรวจสอบสิทธิ์แอป
ดูข้อมูลเพิ่มเติมเกี่ยวกับการตรวจสอบสิทธิ์ใน Chat ได้ที่ภาพรวมการตรวจสอบสิทธิ์
ทรัพยากรและเมธอดของ API
ทรัพยากรและวิธีการ REST จะมอบการเข้าถึงแบบไม่พร้อมกันไปยังพื้นที่ใน Chat, สมาชิกในพื้นที่ทำงาน, ข้อความ, รีแอ็กชันข้อความ และไฟล์แนบของข้อความ
- พื้นที่ทำงาน
พื้นที่ทำงานคือที่ที่ผู้คนและแอปสามารถสนทนาและแชร์ไฟล์ได้ พื้นที่ทำงานมีหลายประเภท ข้อความส่วนตัว (DM) คือการสนทนาแบบ 1:1 ระหว่างผู้ใช้ 2 คนหรือผู้ใช้ 1 คนกับแอป Chat แชทเป็นกลุ่มคือการสนทนาระหว่างผู้ใช้ 3 คนขึ้นไปกับแอป Chat พื้นที่ทำงานที่มีชื่อเป็นพื้นที่ถาวรที่ผู้ใช้ส่งข้อความ แชร์ไฟล์ และทำงานร่วมกัน
ทรัพยากร
spaces
แสดงถึงพื้นที่ทำงานพื้นที่ทำงานรองรับเมธอดต่อไปนี้
- สร้างพื้นที่ทำงาน ซึ่งเป็นที่ที่ผู้คนและแอปสามารถพูดคุยกันและแชร์ไฟล์ได้
- ตั้งค่าพื้นที่ทำงาน เพื่อสร้างพื้นที่ทำงาน รวมถึงเพิ่มบุคคลและแอป Chat ไปยังพื้นที่ดังกล่าว
- รับพื้นที่ทำงาน เพื่อดูรายละเอียดเกี่ยวกับพื้นที่ทำงาน
- ระบุพื้นที่ทำงาน เพื่อดูรายการพื้นที่ทำงานที่มีการแบ่งหน้าและสามารถกรองได้
- อัปเดตพื้นที่ทำงาน เพื่อเปลี่ยนแปลงแอตทริบิวต์เกี่ยวกับพื้นที่ทำงาน เช่น ชื่อที่แสดง คำอธิบาย และหลักเกณฑ์ที่ผู้ใช้จะเห็นได้
- ลบพื้นที่ทำงาน เมื่อไม่จำเป็นต้องใช้แล้ว
- ค้นหาข้อความส่วนตัว (DM) เพื่อแสดง DM ระหว่างผู้ใช้ 2 คน หรือส่ง DM ระหว่างผู้ใช้กับแอป Chat การโทร
- สมาชิก
สมาชิกคือผู้ใช้และแอป Chat ที่เข้าร่วมหรือได้รับเชิญไปยังพื้นที่ทำงาน
ทรัพยากร
spaces.members
เป็นตัวแทนของสมาชิกสมาชิกจะรองรับวิธีการต่อไปนี้
- สร้างการเป็นสมาชิก เพื่อเพิ่มผู้ใช้หรือแอปไปยังพื้นที่ทำงาน
- สมัครสมาชิกเพื่อดูรายละเอียดเกี่ยวกับการเป็นสมาชิก
- แสดงรายการการเป็นสมาชิก เพื่อดูรายการสมาชิกที่มีเลขหน้าและสามารถกรองได้ในพื้นที่ทำงาน
- อัปเดตการเป็นสมาชิก เพื่อเปลี่ยนแปลงแอตทริบิวต์เกี่ยวกับการเป็นสมาชิก เช่น เปลี่ยนสมาชิกในพื้นที่ทำงานเป็นผู้จัดการพื้นที่ทำงาน หรือเปลี่ยนผู้จัดการพื้นที่ทำงานเป็นสมาชิกพื้นที่ทำงาน
- ลบการเป็นสมาชิก เพื่อนำผู้ใช้ออกจากพื้นที่ทำงาน
- ข้อความ
ข้อความหมายรวมถึงการสื่อสารจาก ข้อความ และการ์ด ที่โพสต์ในพื้นที่ทำงาน สามารถแนบไฟล์ไปกับข้อความได้ ผู้ใช้จะแสดงความรู้สึกต่อข้อความได้โดยการใส่อีโมจิต่อท้าย
ทรัพยากร
spaces.messages
แสดงถึงข้อความข้อความรองรับวิธีการต่อไปนี้
- สร้างข้อความเพื่อโพสต์ข้อความในข้อความหรือการ์ด และคุณยังเริ่มหรือตอบกลับชุดข้อความได้ด้วย
- รับข้อความ เพื่อดูรายละเอียดเกี่ยวกับข้อความ เช่น เวลาที่ส่งหรือสิ่งที่เขียน
- แสดงรายการข้อความ เพื่อดูรายการข้อความที่ใส่เลขหน้าและสามารถกรองได้ในพื้นที่ทำงาน
- อัปเดตข้อความ เพื่อเปลี่ยนแอตทริบิวต์ของข้อความ เช่น ข้อมูลที่บอก คุณยังเพิ่มข้อความต่อท้าย ข้อความของการ์ด หรือการ์ดใน ข้อความได้ด้วย
- ลบข้อความ เมื่อไม่จำเป็นต้องใช้แล้ว
- รีแอ็กชัน
รีแอ็กชันจะแสดงอีโมจิที่ผู้คนใช้เพื่อแสดงความรู้สึกต่อข้อความ เช่น 👍, 🚲 และ 🌞
ทรัพยากร
spaces.messages.reactions
แสดงถึงความรู้สึกการแสดงความรู้สึกรองรับวิธีการต่อไปนี้
- สร้างรีแอ็กชัน เพื่อแนบอีโมจิในข้อความ
- แสดงรีแอ็กชัน เพื่อดูรายการรีแอ็กชันที่มีการแบ่งหน้าและสามารถกรองได้ต่อข้อความ
- ลบรีแอ็กชัน เพื่อนำอีโมจิออกจากข้อความ
- สื่อและไฟล์แนบ
สื่อหมายถึงไฟล์ที่อัปโหลดไปยัง Google Chat เช่น รูปภาพ วิดีโอ และเอกสาร
ทรัพยากร
media
แสดงถึงสื่อที่แนบกับข้อความไฟล์แนบเป็นสื่อ (ไฟล์) ที่แนบมากับข้อความ
โดยทรัพยากร
spaces.messages.attachments
จะแทนไฟล์แนบ ไฟล์แนบจะประกอบด้วยสื่อและข้อมูลเมตา ที่เกี่ยวข้องซึ่งแนบมากับข้อความสื่อและไฟล์แนบรองรับวิธีการต่อไปนี้
- อัปโหลดสื่อเป็นไฟล์แนบ เพื่ออัปโหลดสื่อไปยัง Google Chat แล้วแนบไปกับข้อความ
- ดาวน์โหลดสื่อเป็นไฟล์แนบ เพื่อดาวน์โหลดสื่อจาก Google Chat เป็นไฟล์ไบนารี
- รับไฟล์แนบ เพื่อเรียกข้อมูลเมตาเกี่ยวกับไฟล์แนบของข้อความ
- กิจกรรมใน Space
กิจกรรมในพื้นที่ทำงานแสดงถึงการเปลี่ยนแปลงของพื้นที่ทำงานหรือทรัพยากรย่อยของพื้นที่ทำงานนั้น ซึ่งรวมถึงสมาชิก ข้อความ และรีแอ็กชัน
ทรัพยากร
spaces.spaceEvent
แสดงถึงเหตุการณ์ในพื้นที่ทำงานกิจกรรมในพื้นที่ทำงานรองรับวิธีการต่อไปนี้
- รับเหตุการณ์ในพื้นที่ทำงานเพื่อแสดงรายละเอียดเกี่ยวกับเหตุการณ์ที่เกิดขึ้นในพื้นที่ทำงาน
- แสดงรายการเหตุการณ์ในพื้นที่ทำงาน เพื่อดูรายการเหตุการณ์ที่เกิดขึ้นในพื้นที่ทำงาน
- สถานะการอ่านของผู้ใช้
สถานะการอ่านของผู้ใช้คือทรัพยากรแบบ Singleton ที่แสดงรายละเอียดเกี่ยวกับข้อความที่อ่านล่าสุดของผู้ใช้ที่ระบุในพื้นที่ใน Google Chat หรือชุดข้อความ
ทรัพยากร
users.spaces
แสดงสถานะการอ่านของผู้ใช้ในพื้นที่ทำงานทรัพยากร
users.spaces.threads
แสดงสถานะการอ่านของผู้ใช้ในชุดข้อความสถานะการอ่านของผู้ใช้รองรับเมธอดต่อไปนี้
- รับสถานะการอ่านของพื้นที่ทำงาน เพื่อแสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน
- อัปเดตสถานะการอ่านของพื้นที่ทำงานเพื่ออัปเดตสถานะการอ่านของผู้ใช้ภายในพื้นที่ทำงาน
- รับสถานะการอ่านของชุดข้อความ เพื่อแสดงรายละเอียดเกี่ยวกับสถานะการอ่านของผู้ใช้ภายในชุดข้อความ