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

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

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

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

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

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

ชื่อประเภท เมธอด และฟิลด์

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

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

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

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

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

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

เวอร์ชัน API

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

  • v1: เสถียร

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

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