แนวทางปฏิบัติแนะนำ

ปรับปรุงประสบการณ์โดยรวมของผู้ใช้โดยทำตามคำแนะนำเหล่านี้สำหรับการออกแบบส่วนเสริมของ Google Meet

แนวทางปฏิบัติแนะนำสำหรับการให้สิทธิ์

เราขอแนะนำให้คุณใช้แนวทางปฏิบัติแนะนำต่อไปนี้สำหรับส่วนเสริมของ Google Meet ที่ต้องมีการตรวจสอบสิทธิ์หรือการให้สิทธิ์

ใช้การลงชื่อเข้าใช้ด้วย Google

ผู้ใช้ส่วนเสริมของ Google Workspace หลายคนจะลงชื่อเข้าใช้ Google ไว้แล้วก่อนเข้าร่วมการประชุม ดังนั้น การมี Google One Tapเป็นตัวเลือกจะช่วยให้ผู้ใช้คลิกน้อยลงเมื่อทำตามขั้นตอนการลงชื่อเข้าใช้ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อ จัดการวิธีการลงชื่อเข้าใช้สำหรับส่วนเสริม

เปิดหน้าลงชื่อเข้าใช้ของบุคคลที่สามในหน้าต่างใหม่

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

ขอขอบเขตสำหรับ Google APIs อย่างถูกต้อง

หากส่วนเสริมของ Meet เรียกใช้ Google APIs แล้ว คุณต้องระบุรายการขอบเขต OAuth ทั้งหมด ที่ส่วนเสริมของคุณต้องใช้ โดยทำได้ในหน้าการกำหนดค่าแอปของ Google Workspace Marketplace หลังจากเพิ่มขอบเขตเหล่านี้แล้ว ผู้ใช้จะเห็นข้อความแจ้งเมื่อติดตั้งส่วนเสริมของ Meet ซึ่งจะบอกให้ผู้ใช้ทราบว่าข้อมูลประเภทใดที่ผู้ใช้จะอนุญาตให้แอปเข้าถึง

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

เมื่อเขียนโค้ดเพื่อเรียกใช้ Google Workspace APIs การทำตามคู่มือเริ่มต้นใช้งาน JavaScript อย่างรวดเร็วเป็นวิธีที่ง่ายที่สุดในการเริ่มต้น แนวทางนี้เป็นไปตามแนวทางปฏิบัติแนะนำสำหรับการใช้ Google Sign-In และหน้าต่างกล่องโต้ตอบ โปรดทราบว่า การเริ่มต้นใช้งานโทเค็น ไคลเอ็นต์ ใน JavaScript ต้องมีการขอขอบเขตที่แอปพลิเคชัน ใช้จริงในรันไทม์แยกกัน ขอบเขตที่ขอเหล่านี้ควรตรงกับขอบเขตในหน้าการกำหนดค่าแอปของ Google Workspace Marketplace เพื่อให้ผู้ใช้ได้รับประสบการณ์ที่ดีที่สุด การซ้ำซ้อนนี้จะช่วยให้มีตัวเลือกสำรองเพื่อจัดการกรณีที่ ผู้ใช้เพิกถอน ขอบเขต

แนวทางปฏิบัติแนะนำในการบำรุงรักษา

แนวทางปฏิบัติแนะนำต่อไปนี้มีไว้สำหรับการเขียนเว็บแอปพลิเคชันที่บำรุงรักษาได้ แต่มีความสำคัญอย่างยิ่งเมื่อเขียนส่วนเสริมของ Meet

ใช้ Google Meet Add-ons SDK เวอร์ชันล่าสุด

เราอัปเดต Meet Add-ons SDK เป็นประจำ SDK เป็นไปตาม การกำหนดเวอร์ชันเชิงความหมาย วิธีค้นหาเวอร์ชันล่าสุด

  • เมื่อใช้ gstatic: SDK เวอร์ชันล่าสุดจะอยู่ใน URL ของ gstatic ที่พบใน วิธีการใช้ SDK
  • เมื่อใช้ npm: เรียกใช้ npm update @googleworkspace/meet-add-ons จากภายใน ไดเรกทอรีที่มี package.json สำหรับเว็บไซต์ที่โฮสต์ส่วนเสริมของ Meet

สร้างโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google สำหรับการจัดเตรียม

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

เราขอแนะนำให้ สร้างโปรเจ็กต์ที่อยู่ในระบบคลาวด์ของ Google แยกต่างหากที่เผยแพร่แบบส่วนตัวในองค์กรเพื่อหลีกเลี่ยงการทำให้ใช้งานได้ไปยังเวอร์ชันที่ใช้งานจริงโดยตรง โปรเจ็กต์ที่อยู่ในระบบคลาวด์นี้จะโฮสต์ทั้งสภาพแวดล้อมการจัดเตรียมและการพัฒนาสำหรับส่วนเสริมของ Meet การเข้าถึงโปรเจ็กต์ที่อยู่ในระบบคลาวด์นี้ควรจำกัดไว้สำหรับทีมขนาดเล็กที่ทำงานเกี่ยวกับการพัฒนาส่วนเสริมโดยตรง

หากต้องการสร้างสภาพแวดล้อมทางเลือกเหล่านี้สำหรับส่วนเสริม คุณต้องโฮสต์สภาพแวดล้อมทางเลือกของเว็บแอปพลิเคชันที่มีส่วนเสริมอยู่ในโดเมนที่คุณเป็นเจ้าของก่อน จากนั้น คุณจะสร้างสภาพแวดล้อมทางเลือกสำหรับ ส่วนเสริมของ Meet ได้โดยเพิ่ม การติดตั้งใช้งาน เพิ่มเติมลงในโปรเจ็กต์ Google Cloud สำหรับการจัดเตรียม การติดตั้งใช้งานใหม่เหล่านี้ควรมีไฟล์ Manifest ที่ชี้ไปยังสภาพแวดล้อมทางเลือกของเว็บแอปพลิเคชัน จากนั้นเราขอแนะนำให้คุณติดตั้งสภาพแวดล้อมส่วนเสริมแต่ละรายการดังนี้

  • การจัดเตรียม: เผยแพร่เวอร์ชันการจัดเตรียมแบบส่วนตัว เพื่อให้ทุกคนในองค์กรช่วยทดสอบได้
  • การพัฒนา: คลิก ติดตั้ง ในคอลัมน์การดำเนินการ เพื่อติดตั้ง ส่วนเสริมของ Meet เวอร์ชันการพัฒนาลงในบัญชีของคุณเท่านั้น

เขียนการทดสอบ

เราขอแนะนำให้เขียนการทดสอบหน่วยก่อนที่จะติดตั้งใช้งานส่วนเสริมของ Meet ในสภาพแวดล้อมการพัฒนา การทดสอบหน่วยควรมีข้อมูลต่อไปนี้

  • การจำลอง Meet Add-ons SDK แล้วยืนยันว่าส่วนเสริมของ Meet เรียกใช้ฟังก์ชัน SDK ตามที่คาดไว้
  • การทำ Unit Test ฟังก์ชันการทำงานทั้งหมดที่ไม่เกี่ยวข้องกับ SDK ของส่วนเสริมด้วยเฟรมเวิร์กการทดสอบเว็บที่คุณต้องการ

แนวทางปฏิบัติแนะนำสำหรับประสบการณ์ของผู้ใช้

แนวทางปฏิบัติแนะนำต่อไปนี้จะช่วยให้ส่วนเสริมของ Meet ใช้งานง่ายและมีประสิทธิภาพมากขึ้น

จัดการสถานะเริ่มต้นทั้งหมดในแผงด้านข้าง

เราขอแนะนำอย่างยิ่งให้ตั้งค่าส่วนเสริมตาม การดำเนินการของผู้ใช้ในแผงด้านข้าง โดยทำได้โดยการตั้งค่าสถานะเริ่มต้นของกิจกรรม ใน JavaScript. ผู้เริ่มส่วนเสริม (โดยปกติคือ ผู้จัดการประชุม) ควรตั้งค่าข้อมูลทั้งหมดที่จะป้อนลงใน ActivityStartingState ภายในแผงด้านข้าง คุณสามารถคิดว่ามุมมองแรกของแผงด้านข้างเป็นแบบฟอร์มที่ควบคุมการตั้งค่าส่วนเสริม

ปิดแผงด้านข้างเมื่อไม่ใช้งาน

หลังจากเริ่มกิจกรรมโดยการเรียกใช้เมธอด startActivity() แล้ว คุณควรเปิดแผง ด้านข้างไว้เฉพาะในกรณีที่เป็นส่วนสำคัญ ของประสบการณ์การใช้งานส่วนเสริมของ Google Meet คุณสามารถปิด แผงด้านข้างเมื่อเวทีหลัก เปิดแล้วโดยการเรียกใช้ unloadSidePanel() เมธอด

โปรโมตส่วนเสริมของ Meet ผ่านการแชร์หน้าจอ

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

หลักเกณฑ์การออกแบบโลโก้

ปฏิบัติตามหลักเกณฑ์เหล่านี้เมื่อออกแบบโลโก้เฉพาะของ Meet เพื่อให้โลโก้ดูดีที่สุดทั้งในปัจจุบันและอนาคต

ใช้รูปแบบไฟล์ PNG ขนาด 256px x 256px

ใช้ความโปร่งใส

ตรวจสอบว่าโลโก้โหมดมืดดูดีในโหมดมืดโดยใช้เครื่องมือสำหรับนักพัฒนาแอปสำหรับส่วนเสริมของ Meet

ตรวจสอบว่าโลโก้ (และ เนื้อหากราฟิกอื่นๆ) ดูดีในโหมดคอนทราสต์สูงโดยใช้เครื่องมือตรวจสอบคอนทราสต์ เช่น Contrast Checker ของ Web Accessibility In Mind (WebAIM)

ปฏิบัติตามข้อกำหนดด้านกราฟิกสำหรับการผสานรวมแอปที่เฉพาะเจาะจง

อย่าใส่ระยะขอบในรูปภาพ ให้ขยายรูปภาพไปจนถึงขอบเขตของไฟล์แทน