หน้านี้อธิบายวิธีสร้างส่วนเสริมของ Google Workspace ที่ทำงานใน Google Chat โดยใช้บริการ HTTP
การเริ่มต้นอย่างรวดเร็วนี้แสดงวิธีสร้างบริการ HTTP โดยใช้บริการ Google Cloud หากต้องการสร้างแอป Chat คุณต้องเขียนและทำให้ ฟังก์ชัน Cloud Run ใช้งานได้ ซึ่งแอป Chat จะใช้ฟังก์ชันนี้เพื่อตอบกลับข้อความของผู้ใช้
สถาปัตยกรรม HTTP ช่วยให้คุณกำหนดค่า Chat เพื่อผสานรวมกับ Google Cloud หรือเซิร์ฟเวอร์ภายในองค์กรได้โดยใช้ HTTP ดังที่แสดงในแผนภาพต่อไปนี้
ในแผนภาพข้างต้น ผู้ใช้ที่โต้ตอบกับแอป Chat HTTP จะมีโฟลว์ข้อมูลดังนี้
- ผู้ใช้ส่งข้อความใน Chat ไปยังแอป Chat ไม่ว่าจะเป็นในข้อความส่วนตัวหรือในพื้นที่ทำงานใน Chat
- ระบบจะส่งคำขอ HTTP ไปยังเว็บเซิร์ฟเวอร์ ซึ่งอาจเป็นระบบคลาวด์หรือระบบภายในองค์กรที่มีตรรกะของแอป Chat
- ตรรกะของแอป Chat สามารถผสานรวมกับบริการ Google Workspace (เช่น ปฏิทินและชีต), บริการอื่นๆ ของ Google (เช่น Maps, YouTube และ Vertex AI) หรือบริการเว็บอื่นๆ (เช่น ระบบการจัดการโปรเจ็กต์หรือเครื่องมือออกตั๋ว) ก็ได้
- เว็บเซิร์ฟเวอร์จะส่งการตอบกลับ HTTP กลับไปยังบริการแอปใน Chat ใน Chat
- ระบบจะส่งการตอบสนองไปยังผู้ใช้
- แอป Chat สามารถเรียก Chat API เพื่อโพสต์ข้อความแบบไม่พร้อมกันหรือดำเนินการอื่นๆ ได้
สถาปัตยกรรมนี้มีความยืดหยุ่นในการใช้ไลบรารีและคอมโพเนนต์ที่มีอยู่ในระบบอยู่แล้ว เนื่องจากแอป Chat เหล่านี้สามารถออกแบบโดยใช้ภาษาโปรแกรมต่างๆ ได้
วัตถุประสงค์
- ตั้งค่าสภาพแวดล้อม
- สร้างและทำให้ฟังก์ชัน Cloud Run ใช้งานได้
- กำหนดค่าส่วนเสริมของ Google Workspace สำหรับแอป Chat
- ทดสอบแอป
ข้อกำหนดเบื้องต้น
- บัญชี Google Workspace ระดับ Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat
- โปรเจ็กต์ Google Cloud ที่เปิดใช้การเรียกเก็บเงินแล้ว หากต้องการตรวจสอบว่าโปรเจ็กต์ที่มีอยู่เปิดใช้การเรียกเก็บเงินแล้ว ให้ดูที่ ยืนยัน สถานะการเรียกเก็บเงินของโปรเจ็กต์ หากต้องการสร้างโปรเจ็กต์และตั้งค่าการเรียกเก็บเงิน ให้ดูที่ สร้างโปรเจ็กต์ Google Cloud
ตั้งค่าสภาพแวดล้อม
ก่อนที่จะใช้ Google API คุณต้องเปิด API เหล่านั้นในโปรเจ็กต์ Google Cloud คุณสามารถเปิด API อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud เดียวได้ในคอนโซล Google Cloud ให้เปิดใช้ Cloud Build API, Cloud Functions API, Cloud Pub/Sub API, Cloud Logging API, Artifact Registry API และ Cloud Run API
สร้างและทำให้ฟังก์ชัน Cloud Run ใช้งานได้
สร้างและทำให้ฟังก์ชัน Cloud Run ใช้งานได้ ซึ่งจะสร้างการ์ด Chat ที่มีชื่อที่แสดงและรูปโปรไฟล์ของผู้ส่ง เมื่อแอป Chat ได้รับข้อความ แอปจะเรียกใช้ฟังก์ชันและตอบกลับด้วยการ์ด
หากต้องการสร้างและทำให้ฟังก์ชันสำหรับแอป Chat ใช้งานได้ ให้ทำตามขั้นตอนต่อไปนี้
Node.js
ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Run
ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว
คลิกเขียนฟังก์ชัน
ในหน้าสร้างบริการ ให้ตั้งค่าฟังก์ชันดังนี้
- ป้อน
addonchatappในช่องชื่อบริการ - เลือกภูมิภาคในรายการภูมิภาค
- เลือก Node.js เวอร์ชันล่าสุดในรายการรันไทม์
- ในส่วนการตรวจสอบสิทธิ์ ให้เลือกกำหนดให้มีการตรวจสอบสิทธิ์
- คลิกสร้าง แล้วรอให้ Cloud Run สร้างบริการ คอนโซลจะเปลี่ยนเส้นทางคุณไปยังแท็บแหล่งที่มา
- ป้อน
ในแท็บแหล่งที่มา ให้ทำดังนี้
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
avatarApp - แทนที่เนื้อหาของ
index.jsด้วยโค้ดต่อไปนี้
- คลิกบันทึกและทำให้ใช้งานได้อีกครั้ง
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
Python
ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Run
ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว
คลิกเขียนฟังก์ชัน
ในหน้าสร้างบริการ ให้ตั้งค่าฟังก์ชันดังนี้
- ป้อน
addonchatappในช่องชื่อบริการ - เลือกภูมิภาคในรายการภูมิภาค
- เลือก Python เวอร์ชันล่าสุดในรายการรันไทม์
- ในส่วนการตรวจสอบสิทธิ์ ให้เลือกกำหนดให้มีการตรวจสอบสิทธิ์
- คลิกสร้าง แล้วรอให้ Cloud Run สร้างบริการ คอนโซลจะเปลี่ยนเส้นทางคุณไปยังแท็บแหล่งที่มา
- ป้อน
ในแท็บแหล่งที่มา ให้ทำดังนี้
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
avatar_app - แทนที่เนื้อหาของ
main.pyด้วยโค้ดต่อไปนี้
- คลิกบันทึกและทำให้ใช้งานได้อีกครั้ง
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
Java
ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Run
ตรวจสอบว่าได้เลือกโปรเจ็กต์สำหรับแอป Chat แล้ว
คลิกเขียนฟังก์ชัน
ในหน้าสร้างบริการ ให้ตั้งค่าฟังก์ชันดังนี้
- ป้อน
addonchatappในช่องชื่อบริการ - เลือกภูมิภาคในรายการภูมิภาค
- เลือก Java เวอร์ชันล่าสุดในรายการรันไทม์
- ในส่วนการตรวจสอบสิทธิ์ ให้เลือกกำหนดให้มีการตรวจสอบสิทธิ์
- คลิกสร้าง แล้วรอให้ Cloud Run สร้างบริการ คอนโซลจะเปลี่ยนเส้นทางคุณไปยังแท็บแหล่งที่มา
- ป้อน
ในแท็บแหล่งที่มา ให้ทำดังนี้
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
App - เปลี่ยนชื่อไฟล์ Java เริ่มต้นเป็น
src/main/java/com/google/chat/avatar/App.java - แทนที่เนื้อหาของ
App.javaด้วยโค้ดต่อไปนี้
- ในจุดเริ่มต้น ให้ลบข้อความเริ่มต้นแล้วป้อน
แทนที่เนื้อหาของ
pom.xmlด้วยโค้ดต่อไปนี้- คลิกบันทึกและทำให้ใช้งานได้อีกครั้ง
หน้าข้อมูลรายละเอียดบริการ Cloud Run จะเปิดขึ้น รอให้ฟังก์ชันทำให้ใช้งานได้
กำหนดค่าส่วนเสริม
หลังจากทำให้ฟังก์ชัน Cloud Run ใช้งานได้แล้ว ให้ทำตามขั้นตอนต่อไปนี้เพื่อสร้างส่วนเสริมและทำให้แอป Google Chat ใช้งานได้
ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Run
ตรวจสอบว่าได้เลือกโปรเจ็กต์ที่เปิดใช้ Cloud Run แล้ว
คลิก addonchatapp ในรายการฟังก์ชัน
ในหน้ารายละเอียดบริการ ให้คัดลอก URL ของฟังก์ชัน URL จะลงท้ายด้วย
run.appในช่องค้นหาของ Google Cloud ให้ค้นหา "Google Chat API" แล้ว คลิก Google Chat API และคลิก จัดการ
คลิกการกำหนดค่า แล้วตั้งค่าแอป Google Chat ดังนี้
- ป้อน
Add-on Chat appในชื่อแอป - ป้อน
https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.pngใน URL ของรูปโปรไฟล์ - ป้อน
Add-on Chat appใน คำอธิบาย - เลือกเข้าร่วมพื้นที่ทำงานและการสนทนากลุ่ม ในส่วนฟังก์ชันการทำงาน
- เลือก URL ปลายทาง HTTP ในส่วนการตั้งค่าการเชื่อมต่อ
- ในส่วนทริกเกอร์ ให้เลือกใช้ URL ปลายทาง HTTP ทั่วไปสำหรับ ทริกเกอร์ทั้งหมด แล้ววาง URL สำหรับทริกเกอร์ฟังก์ชัน Cloud Run ลงใน ช่อง
- ในส่วนระดับการเข้าถึง ให้เลือก ทำให้แอป Google Chat นี้พร้อมใช้งานสำหรับบุคคลและ กลุ่มที่เฉพาะเจาะจง ในโดเมนของคุณ แล้วป้อนอีเมล
- ในส่วนบันทึก ให้เลือกบันทึกข้อผิดพลาดลงใน Logging
- ป้อน
คลิกบันทึก
คัดลอกอีเมลบัญชีบริการ ในส่วนการตั้งค่าการเชื่อมต่อ คุณต้องใช้อีเมลนี้เมื่อให้สิทธิ์ส่วนเสริมในการเรียกใช้ฟังก์ชัน
จากนั้นให้สิทธิ์แอป Chat ในการเรียกใช้ฟังก์ชัน Cloud Run
ให้สิทธิ์ Google Chat ในการเรียกใช้ฟังก์ชัน
หากต้องการให้สิทธิ์ส่วนเสริมของ Google Workspace ในการเรียกใช้ฟังก์ชัน ให้เพิ่มบัญชีบริการส่วนเสริมของ Google Workspace ที่มีบทบาท Cloud Run Service Invoker
ในคอนโซล Google Cloud ให้ไปที่หน้า Cloud Run
ในรายการบริการ Cloud Run ให้เลือกช่องทำเครื่องหมายข้างฟังก์ชันที่รับ (อย่าคลิกฟังก์ชันเอง)
คลิกสิทธิ์ แผงสิทธิ์ จะเปิดขึ้น
คลิกเพิ่มผู้ใช้หลัก
ในส่วนผู้ใช้หลักรายใหม่ ให้ป้อนอีเมลของบัญชีบริการส่วนเสริมของ Google Workspace ที่เชื่อมโยงกับแอป Chat
อีเมลบัญชีบริการจะอยู่ในหน้าการกำหนดค่า Chat API ในส่วนการตั้งค่าการเชื่อมต่อ > URL ปลายทาง HTTP > อีเมลบัญชีบริการ:
ในส่วนเลือกบทบาท ให้เลือก Cloud Run > Cloud Run Invoker
คลิกบันทึก
แอป Chat พร้อมรับและตอบกลับข้อความใน Chat แล้ว
ทดสอบแอป Chat
หากต้องการทดสอบแอป Chat ให้เปิดพื้นที่ทำงานข้อความส่วนตัวที่มีแอป Chat แล้วส่งข้อความ
เปิด Google Chat โดยใช้บัญชี Google Workspace ที่คุณ ระบุไว้เมื่อเพิ่มตัวเองเป็นผู้ทดสอบที่เชื่อถือได้
- คลิก แชทใหม่
- ในช่องเพิ่มบุคคลอย่างน้อย 1 คน ให้พิมพ์ชื่อแอป Chat
เลือกแอป Chat จากผลการค้นหา ข้อความส่วนตัว จะเปิดขึ้น
- ในข้อความส่วนตัวใหม่ที่มีแอป ให้พิมพ์
Helloแล้วกดenter
ข้อความของแอป Chat จะมีการ์ดที่แสดง ชื่อและรูปโปรไฟล์ของผู้ส่ง ดังที่แสดงในรูปภาพต่อไปนี้
หากต้องการเพิ่มผู้ทดสอบที่เชื่อถือได้และดูข้อมูลเพิ่มเติมเกี่ยวกับการทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟ โปรดดู ทดสอบฟีเจอร์แบบอินเทอร์แอกทีฟสำหรับ แอป Google Chat
แก้ปัญหา
เมื่อแอปหรือ การ์ด Google Chat แสดงข้อผิดพลาด อินเทอร์เฟซ Chat จะแสดงข้อความว่า "เกิดข้อผิดพลาด" หรือ "ไม่สามารถดำเนินการตามคำขอของคุณ" บางครั้ง UI ของ Chat จะไม่แสดงข้อความแสดงข้อผิดพลาด แต่แอปหรือ การ์ด Chat จะแสดงผลลัพธ์ที่ไม่คาดคิด เช่น ข้อความการ์ดอาจไม่ ปรากฏขึ้น
แม้ว่าข้อความแสดงข้อผิดพลาดอาจไม่แสดงใน UI ของ Chat ข้อความแสดงข้อผิดพลาดและข้อมูลบันทึกที่อธิบายข้อผิดพลาดจะพร้อมให้คุณใช้งานเพื่อช่วยแก้ไขข้อผิดพลาด เมื่อเปิดการบันทึกข้อผิดพลาดสำหรับแอป Chat หากต้องการความช่วยเหลือในการดู แก้จุดบกพร่อง และแก้ไขข้อผิดพลาด โปรดดู แก้ปัญหาและแก้ไขข้อผิดพลาดของ Google Chat
ล้างข้อมูล
เราขอแนะนำให้คุณลบโปรเจ็กต์ที่อยู่ในระบบคลาวด์เพื่อหลีกเลี่ยงการเรียกเก็บเงินกับบัญชี Google Cloud สำหรับ ทรัพยากรที่ใช้ในบทแนะนำนี้
- ในคอนโซล Google Cloud ให้ไปที่หน้าจัดการทรัพยากร คลิก เมนู > IAM และผู้ดูแลระบบ > จัดการทรัพยากร.
- ในรายการโปรเจ็กต์ ให้เลือกโปรเจ็กต์ที่ต้องการลบ แล้วคลิก ลบ .
- ในกล่องโต้ตอบ ให้พิมพ์รหัสโปรเจ็กต์ แล้วคลิกปิด เพื่อลบ โปรเจ็กต์