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

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

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

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

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

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

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

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

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

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

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

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

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

เวอร์ชัน API

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

  • v1: เสถียร

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

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