กำหนดค่าแอปใน SDK ของ Google Workspace Marketplace

หน้านี้อธิบายวิธีใช้ SDK ของ Google Workspace Marketplace เพื่อกำหนดค่าและ จัดการแอปใน Google Workspace Marketplace

หากต้องการทำให้แอปพร้อมใช้งาน คุณต้องตั้งค่าใน Marketplace SDK SDK ของ Marketplace เป็น ชุดเครื่องมือที่ช่วยให้คุณสร้างและควบคุมแอปใน Marketplace ได้ คุณใช้ Marketplace SDK เพื่อจัดการการตั้งค่า Marketplace เช่น การตั้งค่าต่อไปนี้

• ไม่ว่าแอปของคุณจะพร้อมให้บริการสำหรับองค์กร Google Workspace ที่เฉพาะเจาะจง (แอปส่วนตัว) หรือสำหรับผู้ใช้ Marketplace ทุกคน (แอปสาธารณะ)
• ประเภทผู้ใช้ Marketplace ที่ติดตั้งแอปของคุณได้
• แอปพลิเคชัน Google Workspace ที่แอปของคุณผสานรวมด้วย
• ขอบเขต OAuth ที่แอปของคุณต้องใช้
• ข้อมูลเกี่ยวกับผู้ที่สร้างและดูแลรักษาแอป

ไม่ว่าคุณจะเผยแพร่แอปแบบส่วนตัวหรือแบบสาธารณะ คุณต้อง ใช้ Marketplace SDK เพื่อจัดการแอปใน Marketplace

เปิดใช้ Marketplace SDK

หากยังไม่ได้ดำเนินการ ให้เปิดใช้ Marketplace SDK ในโปรเจ็กต์ Google Cloud

เปิดโปรเจ็กต์ที่อยู่ในระบบคลาวด์ในคอนโซล Google Cloud

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

1. ไปที่หน้าเลือกโปรเจ็กต์ในคอนโซล Google Cloud

   เลือกโปรเจ็กต์ที่อยู่ในระบบคลาวด์

2. เลือกโปรเจ็กต์ Google Cloud ที่ต้องการใช้ หรือคลิกสร้างโปรเจ็กต์ แล้วทำตามวิธีการบนหน้าจอ หากสร้างโปรเจ็กต์ Google Cloud คุณอาจต้องเปิดการเรียกเก็บเงินสำหรับโปรเจ็กต์

เปิดใช้ Marketplace SDK

• เปิดใช้ SDK ของ Google Workspace Marketplace ในคอนโซล Google Cloud

  เปิดใช้ SDK

กำหนดการตั้งค่าการกำหนดค่าสำหรับแอป

ข้อมูลอ้างอิงต่อไปนี้อธิบายการตั้งค่าที่มีในหน้าการกำหนดค่า แอปของ SDK สำหรับ Marketplace

เลือกผู้ที่ดูและติดตั้งแอปของคุณได้

เมื่อกำหนดค่าแอป คุณจะระบุผู้ใช้ที่เข้าถึงแอปได้โดยใช้ การตั้งค่าต่อไปนี้

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

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

• ควบคุมว่าผู้ใช้จะดูแอปใน Marketplace และติดตั้งแอปในนามของผู้ใช้ได้หรือไม่
• ใช้รายการที่อนุญาตเพื่อจัดการและดูแลแอปสำหรับองค์กร หากคุณ กำลังพัฒนาแอปสำหรับองค์กรที่ใช้รายการที่อนุญาต โปรดสอบถาม ผู้ดูแลระบบเกี่ยวกับการเพิ่มแอปไปยังรายการที่อนุญาต
• ปิดแอปพลิเคชัน Google Workspace บางอย่าง เช่น การนำสิทธิ์เข้าถึง Google Chat, แอป Google Chat หรือทั้ง 2 อย่างออก ในกรณีเหล่านี้ ผู้ใช้จะติดตั้งแอปของคุณจาก Marketplace ไม่ได้

ดูวิธีที่ผู้ดูแลระบบจัดการการเข้าถึง Marketplace ได้ที่เอกสาร ความช่วยเหลือสำหรับผู้ดูแลระบบ Marketplace

การตั้งค่าระดับการเข้าถึงแอป

คุณจะเห็นตัวเลือกระดับการมองเห็นแอปหากใช้บัญชี Google Workspace (บัญชีที่สร้างโดยองค์กรที่ทำงานหรือโรงเรียน) หากคุณใช้บัญชีสำหรับผู้ใช้ทั่วไป (บัญชีที่ลงท้ายด้วย "@gmail.com") คุณจะเผยแพร่ได้แบบสาธารณะเท่านั้น

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

หากเลือกเผยแพร่เป็นไม่อยู่ในรายการ รายการแอปจะไม่แสดงในผลการเรียกดู หรือผลการค้นหา ผู้ใช้จะเข้าถึงหน้า Store ของแอปได้ด้วย URL โดยตรงเท่านั้น

หากต้องการจำกัดประเทศและภูมิภาคที่แอปพร้อมให้บริการ คุณต้อง ตั้งค่าในส่วนการจัดจำหน่ายเมื่อสร้างข้อมูลใน Store

การตั้งค่าการติดตั้งแอป

ตัวเลือกการตั้งค่าการติดตั้งจะกำหนดว่าผู้ใช้หรือผู้ดูแลระบบ Google Workspace จะติดตั้งแอปจากหน้าข้อมูลสินค้าใน Storeใน Marketplace ได้หรือไม่

• ติดตั้งโดยผู้ใช้และผู้ดูแลระบบ (ค่าเริ่มต้น): ผู้ใช้แต่ละรายหรือผู้ดูแลระบบสามารถติดตั้งแอปสำหรับโดเมน หน่วยขององค์กร หรือกลุ่มผู้ใช้ได้ นโยบายโดเมนของผู้ใช้อาจป้องกันไม่ให้ผู้ใช้ติดตั้ง แอปแม้ว่าจะเปิดใช้การติดตั้งแต่ละรายการแล้วก็ตาม
• ติดตั้งโดยผู้ดูแลระบบเท่านั้น: มีเพียงผู้ดูแลระบบเท่านั้นที่ติดตั้งแอปสำหรับโดเมน หน่วยขององค์กร หรือกลุ่มผู้ใช้ได้ แอปของคุณจะปรากฏในผลการค้นหาของ Google Workspace Marketplace สำหรับผู้ดูแลระบบและผู้ที่ไม่ได้เข้าสู่ระบบบัญชี Google เท่านั้น เลือกตัวเลือกนี้หากแอปต้องมีการติดตั้งโดเมน

การตั้งค่าการติดตั้งและระดับการเข้าถึงที่พบบ่อย

ตารางต่อไปนี้สรุปตัวเลือกการกำหนดค่าแอปที่พบบ่อยบางส่วนสำหรับการ ติดตั้งและการแสดงผล

ระบุวิธีที่แอปของคุณผสานรวมกับแอปพลิเคชัน Google Workspace

ตัวเลือกการผสานรวมแอปช่วยให้คุณเลือกบริการ Google Workspace ที่ออกแบบมาเพื่อให้แอปหรือส่วนเสริมของคุณทำงานด้วยได้ เช่น ส่วนเสริมของ Google Workspace หรือแอป Google Chat คุณต้องเลือกตัวเลือกอย่างน้อย 1 รายการ ในบางกรณี คุณสามารถรวมการผสานรวมแอปหลายรายการไว้ในข้อมูลแอปได้ ดูแสดงรายการการผสานรวมแอปร่วมกัน

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

• Unsaved: คุณได้เพิ่มหรือแก้ไขการผสานรวม แต่ยังไม่ได้บันทึกการเปลี่ยนแปลงในแท็บการกำหนดค่าแอป
• Draft: ระบบบันทึกการเปลี่ยนแปลงแล้ว แต่ยังไม่ได้เผยแพร่
• Under review: คุณส่งการผสานรวมแอปที่อัปเดตแล้วเพื่อรับการตรวจสอบ
• Published: การผสานรวมแอปของคุณจะรวมอยู่ใน ข้อมูลใน Marketplace

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

ระบุระดับการเข้าถึงที่แอปของคุณต้องการ

ในส่วนขอบเขต OAuth ให้ระบุรายการขอบเขต OAuth 2.0 ทั้งหมดที่แอปของคุณ ต้องการ ขอบเขต OAuth ที่คุณป้อนที่นี่ควรตรงกับสิ่งที่แสดงในหน้าจอขอความยินยอม OAuth และไฟล์ Manifest ของ Apps Script (หากมี)

หากรวมการผสานรวมแอปมากกว่า 1 รายการ โปรดตรวจสอบว่าได้เพิ่มขอบเขตจากแต่ละรายการลงในหน้าการกำหนดค่าแอป SDK ของ Marketplace และหน้าจอขอความยินยอม OAuth

ใช้ขอบเขตที่แคบที่สุดเท่าที่จะเป็นไปได้เสมอ (เช่น อย่ารวมขอบเขต Drive แบบเต็มหากคุณต้องการเพียงขอบเขตแบบอ่านอย่างเดียว)

สำหรับโปรเจ็กต์ Apps Script โปรดดูรายละเอียดเพิ่มเติมที่ขอบเขต การให้สิทธิ์

ให้ข้อมูลเกี่ยวกับนักพัฒนาแอป

ในส่วนข้อมูลนักพัฒนาแอป ให้กรอกข้อมูลติดต่อและรายละเอียดอื่นๆ ฟิลด์เหล่านี้จะปรากฏในหน้าข้อมูลสินค้าใน Store ของแอป

บันทึกการตั้งค่าการกำหนดค่าแอปใน SDK ของ Marketplace

ใช้ข้อมูลจากส่วนก่อนหน้า บันทึกการกำหนดค่าแอปใน Marketplace SDK โดยทำดังนี้

1. ในคอนโซล Google Cloud ให้ไปที่หน้าการกำหนดค่าแอปของ SDK สำหรับ Marketplace โดยทำดังนี้

   ไปที่หน้าการกำหนดค่า SDK ของ Marketplace

2. กรอกข้อมูลในแต่ละส่วนตามที่ระบุไว้ในส่วนก่อนหน้า

3. คลิกบันทึกฉบับร่าง

4. (ไม่บังคับ) คุณดูข้อมูลวิเคราะห์เกี่ยวกับการใช้งานแอปใน Google Analytics ได้ โดยให้เพิ่มรหัส Google Analytics ใน Marketplace SDK

   1. ไปที่แท็บ Analytics
   2. ป้อนรหัส Google Analytics
   3. คลิกบันทึก

แก้ปัญหา

ส่วนนี้จะอธิบายปัญหาที่พบบ่อยที่คุณอาจพบ

ไม่มีสิทธิ์ที่จำเป็นเมื่อเผยแพร่แอปไปยัง Marketplace

คุณเผยแพร่แอปใน Marketplace ไม่ได้เนื่องจาก ความพยายามในการกำหนดค่าแอปพลิเคชันในหน้าการกำหนดค่าแอปของ SDK ของ Marketplace ล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดต่อไปนี้

You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update

ข้อผิดพลาดนี้เกิดขึ้นเมื่อเปิดใช้ Marketplace SDK API และเมื่อใช้บทบาท IAM อื่นที่ไม่ใช่ Editor หรือ Owner

หากต้องการแก้ไขข้อผิดพลาด ให้ใช้วิธีแก้ปัญหาอย่างใดอย่างหนึ่งต่อไปนี้

• ขอให้เจ้าของโปรเจ็กต์มอบบทบาท roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin ให้กับ บัญชีที่ไม่มีสิทธิ์เพื่ออนุญาตให้กำหนดค่าและจัดการ แอปใน Marketplace SDK

• โปรดติดต่อเจ้าของโปรเจ็กต์เพื่อเพิ่มสิทธิ์ที่ขาดหายไปให้กับบทบาทที่กำหนดเองผ่านหน้าIAM และผู้ดูแลระบบ > บทบาทในคอนโซล Google Cloud จากนั้นมอบหมายบทบาทที่กำหนดเองให้กับบัญชีที่มีสิทธิ์ที่ขาดหายไป

• คุณใช้ roles/editor หรือ roles/owner เพื่อเผยแพร่แอปได้ อย่างไรก็ตาม เอกสารประกอบใช้ IAM อย่างปลอดภัย ถือว่าแนวทางปฏิบัตินี้ไม่ดี เนื่องจากจำกัดสิทธิ์เข้าถึงการแก้ไข ทรัพยากรอื่นๆ ในโปรเจ็กต์ได้ยาก