วิธีการเรียกใช้ API ภายนอกจาก Workspace Studio

เวิร์กโฟลว์ของ Google Workspace Studio อาจต้องการข้อมูลจากภายนอก Gmail, Drive หรือ Chat เช่น สถานะคำสั่งซื้อ ตัวเลขจากฐานข้อมูล หรือการตอบกลับจากเครื่องมือภายใน คุณสามารถเพิ่มขั้นตอนเพื่อดึงข้อมูลนี้หรือส่งข้อมูลไปยังบริการอื่นได้ ส่งเว็บฮุคคำสั่งนี้จะส่งคำขอ HTTP ไปยังที่อยู่ของ API ที่คุณระบุไว้

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

สิ่งที่คุณต้องมีก่อนเชื่อมต่อกับ API

ขั้นตอนแรกคือการตรวจสอบว่าองค์กรของคุณสามารถใช้งาน webhook ได้หรือไม่ ฟังก์ชันนี้อยู่ใน... ตัวอย่างแบบจำกัด และถูกปิดใช้งานโดยค่าเริ่มต้น ผู้ดูแลระบบต้องเข้าสู่ระบบก่อน แอป > Google Workspace > Workspace Studio > การตั้งค่า Webhook และเปิดใช้งานสำหรับหน่วยงานที่เกี่ยวข้อง

ในบางเวอร์ชัน ผู้ดูแลระบบยังสามารถจำกัดการเชื่อมต่อให้เหลือเพียงหนึ่งเดียวได้อีกด้วย รายชื่อโดเมนและ URL ที่อนุญาตหากขั้นตอนปรากฏใน Studio แต่ไม่สามารถสื่อสารกับ API ของคุณได้ โปรดตรวจสอบว่าที่อยู่ปลายทางได้รับอนุญาตแล้ว นอกจากนี้ โดยค่าเริ่มต้น การดำเนินการที่เกี่ยวข้องกับ Webhook จะต้องให้ผู้ใช้ตรวจสอบและยืนยันขั้นตอนก่อนดำเนินการ

จากบริการภายนอก คุณต้องทราบ URL ของบริการนั้น วิธีการ HTTP ที่รองรับ และรูปแบบข้อมูลที่บริการนั้นคาดหวัง นอกจากนี้ ตรวจสอบวิธีการตรวจสอบสิทธิ์ด้วย: API สาธารณะแบบอ่านอย่างเดียวจะมีข้อกำหนดที่แตกต่างจาก API ส่วนตัวที่ต้องการโทเค็นหรือส่วนหัวพิเศษ

วิธีการเรียกใช้ API จาก Workspace Studio ทีละขั้นตอน

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

1. กด เพิ่มขั้นตอน และเลือก ส่งเว็บฮุค.
2. เข้าสู่ URL แบบเต็ม ของ API รวมถึงคำนำหน้า https://ต้องระบุที่อยู่ให้แน่นอน: ช่องนี้ไม่รองรับตัวแปรการไหล
3. เลือกวิธีการเชื่อมต่อ HTTP รับ ใช้สำหรับสอบถามข้อมูล; โพสต์เพื่อส่งหรือสร้างบันทึก นอกจากนี้ยังมีให้บริการอีกด้วย ใส่ แก้ไข และลบ.
4. หาก API ต้องการเนื้อหา ให้เขียนลงในช่องเนื้อหา หรือ เพย์โหลดGoogle แนะนำให้ใช้ JSON เมื่อบริการปลายทางคาดหวังรูปแบบนั้น
5. สร้าง การดำเนินการทดสอบตรวจสอบผลลัพธ์และเปิดใช้งานขั้นตอนการทำงานเมื่อคุณตรวจสอบแล้วว่าใช้งานได้

โปรดจำไว้ว่าการทดสอบ ดำเนินการหากคุณตั้งค่า POST เพื่อสร้างเรคอร์ด หรือ DELETE เพื่อลบเรคอร์ด โปรดใช้สภาพแวดล้อมทดสอบหรือข้อมูลที่คุณสามารถแก้ไขได้โดยไม่มีปัญหาเสียก่อน

ตัวอย่าง: การส่งการแจ้งเตือนไปยังเครื่องมือภายนอก

ลองนึกภาพว่าทีมของคุณมี API ที่สร้างการแจ้งเตือนได้ https://api.ejemplo.com/v1/avisosที่อยู่นี้คือ ตัวอย่างประกอบคุณจะต้องแทนที่ด้วยอันที่เป็นของบริการของคุณ หากเอกสารระบุว่ารับ POST และมีเนื้อหาเป็น JSON คุณสามารถกำหนดค่าขั้นตอนด้วยเนื้อหาเช่นนี้ได้ {"tipo":"nuevo_correo","origen":"Workspace Studio"}.

คุณสามารถแทรกได้เช่นกัน ตัวแปรการไหล ตัวอย่างเช่น ในส่วนเนื้อหา ให้ใส่หัวเรื่องของอีเมลที่ทำให้เกิดข้อความนี้ ทำได้โดยใช้ตัวเลือกตัวแปรของ Studio และตรวจสอบผลลัพธ์: หากข้อความที่แทรกมีเครื่องหมายอัญประกาศหรืออักขระพิเศษอื่นๆ อาจทำให้ JSON ผิดรูปได้ สามารถใช้ตัวแปรในเนื้อหาได้ แต่ ไม่อยู่ในช่อง URL.

หากคุณต้องการดึงข้อมูล ให้เลือก GET และป้อน URL ที่กำหนดไว้ซึ่งมีพารามิเตอร์ที่จำเป็นอยู่แล้ว Workspace Studio จะไม่สนใจเนื้อหาใดๆ ที่คุณเขียนไว้ในส่วนเนื้อหาของคำขอ GET

ควรทำอย่างไรกับผลลัพธ์จาก API

ขั้นตอน webhook จะออกจาก การตอบกลับบริการในรูปแบบข้อความ โดยจัดเก็บไว้ในตัวแปรที่พร้อมใช้งานสำหรับขั้นตอนต่อไป คุณสามารถใช้ตัวแปรนี้เพื่อส่งการแจ้งเตือน เขียนสรุป หรือขอให้ขั้นตอน AI ดึงข้อมูลเฉพาะออกมาได้

ตัวอย่างเช่น หาก API ส่งคืนสถานะของคำสั่งซื้อ ขั้นตอนถัดไปสามารถสื่อสารสถานะนั้นไปยังทีมได้ ควรเลือกตัวแปรที่มีคำตอบอย่างชัดเจน: ขั้นตอนต่อๆ ไปจะไม่ได้รับทุกสิ่งที่เกิดขึ้นก่อนหน้านี้โดยอัตโนมัติ จึงควรทดสอบเนื้อหาที่ส่งคืนก่อนที่จะเขียนคำสั่งที่ขึ้นอยู่กับเนื้อหานั้น

หาก API ต้องการการตรวจสอบสิทธิ์หรือตรรกะที่ซับซ้อนกว่านั้น

การกำหนดค่าพื้นฐานที่บันทึกไว้สำหรับ ส่งเว็บฮุค ประกอบด้วย URL วิธีการ และเนื้อหาเพิ่มเติม (ถ้ามี) หากการผสานรวมของคุณจำเป็นต้องได้รับโทเค็น OAuth สร้าง URL ที่มีพารามิเตอร์แปรผัน เพิ่มส่วนหัวเฉพาะ หรือแปลงการตอบกลับก่อนดำเนินการต่อ โปรดตรวจสอบว่าขั้นตอนนี้ครอบคลุมข้อกำหนดเหล่านั้นหรือไม่

หากวิธีนั้นไม่ได้ผล ทางเลือกหนึ่งคือการพัฒนา ขั้นตอนแบบกำหนดเองสำหรับ Workspace Studio ผ่านปลั๊กอิน ในการใช้งาน Google Apps Script บริการดังกล่าว UrlFetchApp ฟังก์ชันนี้ช่วยให้คุณสามารถส่งคำขอไปยัง API ภายนอกและประมวลผลการตอบกลับในรูปแบบ JSON โซลูชันนี้ต้องการการพัฒนาและการกำหนดค่าสิทธิ์ที่เหมาะสม ซึ่งไม่จำเป็นสำหรับคำขอแบบง่ายๆ ที่ขั้นตอนพื้นฐานสามารถจัดการได้อยู่แล้ว

หลีกเลี่ยงการวางรหัสส่วนตัวลงในช่องที่มองเห็นได้ในขั้นตอนการทำงาน หรือฝังรหัสส่วนตัวไว้ใน URL ที่แชร์ ก่อนส่งข้อมูลจาก Gmail, Chat หรือ Calendar ให้ตรวจสอบว่าบริการภายนอกจะได้รับข้อมูลอะไรบ้าง และได้รับอนุญาตให้ประมวลผลข้อมูลนั้นหรือไม่

วิธีการค้นหาข้อผิดพลาดในเว็บฮุค

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

• ขั้นตอนดังกล่าวไม่ปรากฏขึ้น: ตรวจสอบกับผู้ดูแลระบบว่าได้เปิดใช้งาน Webhooks สำหรับหน่วยงานของคุณแล้วหรือไม่
• URL นี้ถูกบล็อก: ตรวจสอบรายชื่อที่อยู่เว็บที่อนุญาต หากเวอร์ชันที่คุณใช้มีข้อจำกัดดังกล่าว
• ข้อผิดพลาด 400: ตรวจสอบรูปแบบเนื้อหาและฟิลด์ที่ API ต้องการ
• ข้อผิดพลาด 401 หรือ 403: ตรวจสอบสิทธิ์และวิธีการยืนยันตัวตนที่บริการนั้นต้องการ
• ข้อผิดพลาด 429: ตรวจสอบว่าคุณได้ใช้จำนวนคำขอเกินขีดจำกัดสำหรับ API เป้าหมายแล้วหรือไม่
• ข้อผิดพลาด 500: ตรวจสอบสถานะและบันทึกของบริการที่ได้รับคำขอ

โปรดคำนึงถึงข้อจำกัดทั่วไปของ Workspace Studio ด้วย: ปัจจุบันรองรับได้สูงสุดเพียงเท่านี้ 25 โฟลว์ต่อผู้ใช้ y 20 ขั้นตอนต่อกระบวนการนอกจากนี้ ยังมีขีดจำกัดการทำงานรวมที่รีเซ็ตทุก 24 ชั่วโมง หากกระบวนการทำงานหลายรายการหยุดทำงาน ให้ตรวจสอบกิจกรรมของกระบวนการเหล่านั้นก่อนที่จะสรุปว่าความล้มเหลวเกิดจาก API

สำหรับการเชื่อมต่อ HTTP แบบง่ายส่วนใหญ่ กระบวนการนั้นตรงไปตรงมา: เปิดใช้งาน webhook กำหนดค่า URL คงที่และวิธีการที่ถูกต้อง ทดสอบคำขอ และใช้การตอบกลับในขั้นตอนต่อไป หากการผสานรวมต้องการการตรวจสอบสิทธิ์ขั้นสูงหรือการแปลงข้อมูลผ่านโค้ด ก็ควรเตรียมขั้นตอนที่กำหนดเองไว้