ภาพรวมของ Google Chat API

หน้านี้แสดงภาพรวมเกี่ยวกับวิธีใช้ Google Chat API และข้อมูลอ้างอิง เอกสารประกอบ

Google Chat API มีทั้ง gRPC และ อินเทอร์เฟซ REST และ ไลบรารีของไคลเอ็นต์ที่รองรับทั้ง 2 ประเภท (ไม่บังคับ) หาก ไลบรารีของไคลเอ็นต์ที่จัดเตรียมไว้ไม่ตรงตามความต้องการของคุณ คุณสามารถเขียนไลบรารี ไลบรารีของไคลเอ็นต์ที่ใช้อินเทอร์เฟซ gRPC หรือ REST

ไลบรารีของไคลเอ็นต์

วิธีที่แนะนำสำหรับนักพัฒนาซอฟต์แวร์ส่วนใหญ่ในการเรียกใช้ Google Chat API คือการสนับสนุนอย่างเป็นทางการ ไลบรารีไคลเอ็นต์ Cloud สำหรับภาษาที่ต้องการ เช่น Python, Java หรือ Node.js

ถ้าคุณเขียนโค้ดด้วยสคริปต์ Google Apps ให้ใช้ บริการ Chat ขั้นสูง แทนการติดตั้งไลบรารีของไคลเอ็นต์

ประเภท วิธีการ และชื่อฟิลด์

ขึ้นอยู่กับว่าคุณใช้ไลบรารีของไคลเอ็นต์, gRPC หรือ REST และประเภท และชื่อช่องสำหรับ Google Chat API จะแตกต่างกันไป

  • ไลบรารีของไคลเอ็นต์ระบบคลาวด์มีการจัดเรียงตามบริการ gRPC และวิธีการของบริการ ไลบรารีของไคลเอ็นต์ Google API ถูกจัดเรียงเป็นบริการที่มีออบเจ็กต์หรือ คลาสที่สอดคล้องกับทรัพยากร REST ซึ่งมี
  • gRPC จะจัดเรียงตามบริการและวิธีการของบริการ
  • REST จัดเรียงตามลำดับชั้นของทรัพยากรและเมธอด
  • ชื่อช่อง gRPC ใช้ตัวอักษรแบบ Snake Case
  • ชื่อช่อง REST ใช้ตัวพิมพ์ใหญ่แบบอูฐ แต่บริการ API จะยอมรับ เคสอูฐหรือเคสงู
  • ชื่อช่องไลบรารีของไคลเอ็นต์จะใช้ลักษณะตัวพิมพ์สำหรับชื่อเรื่อง การใช้ตัวพิมพ์ใหญ่แบบงูหรือแบบงู ขึ้นอยู่กับว่าชื่อไหนเป็นสำนวนของภาษานั้นๆ

บัฟเฟอร์โปรโตคอล

ไม่ว่าคุณจะใช้ไลบรารีของไคลเอ็นต์, REST หรือ gRPC บริการที่สำคัญ ที่กำหนดไว้โดยใช้บัฟเฟอร์โปรโตคอล โดยเฉพาะอย่างยิ่ง บริการ ใช้ proto3

เมื่อเรียก API ช่องคำขอหรือการตอบกลับบางช่องอาจต้องใช้ข้อมูลพื้นฐาน ความเข้าใจเกี่ยวกับ ประเภทที่รู้จักกันดีของบัฟเฟอร์โปรโตคอล

นอกจากนี้ เมื่อเรียกใช้ REST API ฟังก์ชัน ลักษณะการทำงานค่าเริ่มต้นสำหรับโปรโตคอล บัฟเฟอร์อาจทำให้ไม่มีช่องในการตอบกลับ JSON ฟิลด์เหล่านี้คือ เป็นค่าเริ่มต้น เพื่อไม่ให้รวมอยู่ในคำตอบ

เวอร์ชัน API

มีเวอร์ชัน API ต่อไปนี้

  • v1: เสถียร

ตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์

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