หน้านี้อธิบายวิธีใช้ 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
เปิดโปรเจ็กต์ Cloud ใน Google Cloud Console
หากยังไม่ได้เปิด ให้เปิดโปรเจ็กต์ Cloud ที่คุณต้องการใช้ สำหรับตัวอย่างนี้
- ไปที่หน้าเลือกโปรเจ็กต์ใน Google Cloud Console
- เลือกโปรเจ็กต์ Google Cloud ที่ต้องการใช้ หรือคลิกสร้างโปรเจ็กต์ แล้วทำตามวิธีการบนหน้าจอ หากสร้างโปรเจ็กต์ Google Cloud คุณอาจต้องเปิดการเรียกเก็บเงินสำหรับโปรเจ็กต์
เปิดใช้ Marketplace SDK
ก่อนใช้ Google API คุณต้องเปิดใช้ API ในโปรเจ็กต์ Google Cloud คุณเปิด API อย่างน้อย 1 รายการในโปรเจ็กต์ Google Cloud เดียวได้เปิดใช้ SDK ของ Google Workspace Marketplace ใน Google Cloud Console
กำหนดการตั้งค่าการกำหนดค่าสำหรับแอป
ข้อมูลอ้างอิงต่อไปนี้อธิบายการตั้งค่าที่มีในหน้าการกำหนดค่า แอปของ Marketplace SDK
เลือกผู้ที่มีสิทธิ์ดูและติดตั้งแอปของคุณ
เมื่อกำหนดค่าแอป คุณจะระบุผู้ใช้ที่เข้าถึงแอปได้โดยใช้การตั้งค่าต่อไปนี้
- ระดับการมองเห็นแอป: หากคุณเผยแพร่แอปภายในองค์กร 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 จะติดตั้งแอปจากหน้าข้อมูลในร้านค้าใน Marketplace ได้หรือไม่
- ติดตั้งโดยผู้ใช้และผู้ดูแลระบบ (ค่าเริ่มต้น): ผู้ใช้แต่ละรายหรือผู้ดูแลระบบสามารถติดตั้งแอปสำหรับโดเมน หน่วยขององค์กร หรือกลุ่มผู้ใช้ได้ นโยบายโดเมนของผู้ใช้อาจป้องกันไม่ให้ผู้ใช้ติดตั้ง แอปแม้ว่าจะเปิดใช้การติดตั้งแต่ละรายการแล้วก็ตาม
- ติดตั้งโดยผู้ดูแลระบบเท่านั้น: มีเพียงผู้ดูแลระบบเท่านั้นที่ติดตั้งแอปสำหรับโดเมน หน่วยขององค์กร หรือกลุ่มผู้ใช้ได้ แอปของคุณจะปรากฏในผลการค้นหาของ Google Workspace Marketplace สำหรับผู้ดูแลระบบและผู้ที่ไม่ได้เข้าสู่ระบบบัญชี Google เท่านั้น เลือกตัวเลือกนี้หากแอปของคุณ ต้องมีการติดตั้งโดเมน
การตั้งค่าการติดตั้งและการแสดงผลที่พบบ่อย
ตารางต่อไปนี้สรุปตัวเลือกการกำหนดค่าแอปที่พบบ่อยบางส่วนสำหรับการ ติดตั้งและการมองเห็น
ผู้ใช้แอปที่ต้องการ | การตั้งค่าระดับการมองเห็นแอป | การตั้งค่าการติดตั้งแอป | ใครติดตั้งแอปของฉันได้บ้าง | ใครใช้แอปของฉันได้บ้าง | |
---|---|---|---|---|---|
สำหรับแอปที่สร้างขึ้นสำหรับองค์กร Google Workspace | |||||
ผู้ใช้บางรายในองค์กร | ส่วนตัวและไม่เป็นสาธารณะ | ติดตั้งโดยผู้ใช้และผู้ดูแลระบบ | หากได้รับอนุญาต ทุกคนในองค์กรที่มี URL ของข้อมูลแอป | หากได้รับอนุญาต ทุกคนในองค์กรที่มี URL ของข้อมูลแอป | |
องค์กรของคุณ | ส่วนตัว | ติดตั้งโดยผู้ใช้และผู้ดูแลระบบ | ทุกคนในองค์กรของคุณ หากได้รับอนุญาต | ทุกคนในองค์กรของคุณ หากได้รับอนุญาต | |
องค์กรของคุณ | ส่วนตัว | ผู้ดูแลระบบเท่านั้น | ผู้ดูแลระบบ | ผู้ใช้ที่ผู้ดูแลระบบติดตั้งแอปให้ | |
สำหรับแอปที่พร้อมให้บริการแก่ผู้ใช้ภายนอกองค์กร Google Workspace ที่เฉพาะเจาะจง | |||||
ผู้ใช้ในองค์กร Google Workspace | สาธารณะ | ผู้ดูแลระบบเท่านั้น | ผู้ดูแลระบบ | ผู้ใช้ที่ผู้ดูแลระบบติดตั้งแอปให้ | |
ผู้ใช้ Google Workspace ทุกคน | สาธารณะ | ติดตั้งโดยผู้ใช้และผู้ดูแลระบบ |
|
|
ระบุวิธีที่แอปของคุณผสานรวมกับแอปพลิเคชัน Google Workspace
เลือกบริการ Google Workspace ที่ออกแบบมาเพื่อให้ทำงานกับแอปหรือ ส่วนเสริมของคุณ เช่น ส่วนเสริม Google Workspace หรือแอป Google Chat คุณต้องเลือกตัวเลือกอย่างน้อย 1 รายการ ในบางกรณี คุณสามารถรวมการผสานรวมแอปหลายรายการไว้ในข้อมูลแอป ของคุณได้ ดูแสดงรายการการผสานรวมแอปร่วมกัน
คุณอาจต้องให้ข้อมูลเพิ่มเติมและเปิดใช้ API ที่เกี่ยวข้องในโปรเจ็กต์ Google Cloud ทั้งนี้ขึ้นอยู่กับการผสานรวมแอปที่คุณเลือก ตารางต่อไปนี้อธิบายการตั้งค่าเพิ่มเติมที่จำเป็นสำหรับแต่ละรายการ
ส่วนเสริมของ Google Workspace
หากต้องการเผยแพร่ส่วนเสริมของ Google Workspace คุณต้องระบุรหัสการติดตั้งใช้งานของส่วนเสริม
หากต้องการค้นหารหัสการติดตั้งใช้งานใน Apps Script ให้ทำตามขั้นตอนต่อไปนี้
- เปิดส่วนเสริม Google Workspace ในโปรแกรมแก้ไข Apps Script
- คลิกติดตั้งใช้งาน > จัดการการติดตั้งใช้งาน
- คลิกคัดลอกใต้รหัสการทำให้ใช้งานได้
หากต้องการค้นหารหัสการติดตั้งใช้งานสำหรับส่วนเสริม HTTP ให้ทำตามขั้นตอนต่อไปนี้
- ในหน้าการกำหนดค่าแอปในส่วน "ส่วนเสริมของ Google Workspace" ให้คลิก การติดตั้งใช้งาน HTTP หรือการติดตั้งใช้งานอื่นๆ > เลือกการติดตั้งใช้งาน
- เลือกการติดตั้งใช้งานที่ต้องการเผยแพร่
- คลิกเลือก
ส่วนเสริมของเอดิเตอร์ (เอกสาร ชีต สไลด์ ฟอร์ม)
หากต้องการเผยแพร่ส่วนเสริมของเอดิเตอร์ คุณต้องระบุรหัสสคริปต์ของโปรเจ็กต์และเวอร์ชันที่ต้องการเผยแพร่
หากต้องการค้นหารหัสสคริปต์โปรเจ็กต์ ให้ทำตามขั้นตอนต่อไปนี้
- เปิดส่วนเสริมในตัวแก้ไข Apps Script
- คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย
- ในส่วน "รหัส" ให้คัดลอกรหัสสคริปต์
หากต้องการดูเวอร์ชัน ให้ทำตามขั้นตอนต่อไปนี้
- เปิดส่วนเสริมในตัวแก้ไข Apps Script
- ที่ด้านขวาบน ให้คลิกติดตั้งใช้งาน > จัดการการติดตั้งใช้งาน
- หมายเลขเวอร์ชันจะอยู่ใต้ "การกำหนดค่า"
แอป Google Chat
หากต้องการเผยแพร่ แอป Google Chat แบบอินเทอร์แอกทีฟ โปรดดูเอกสารประกอบต่อไปนี้
- หากสร้างแอป Chat เป็นส่วนเสริม คุณต้องกำหนดค่าการตั้งค่าส่วนเสริมใน Chat API ดูขั้นตอนได้ที่ กำหนดค่า แอป Chat ในเอกสารประกอบของส่วนเสริม Google Workspace
- หากสร้างแอป Chat โดยใช้ เหตุการณ์การโต้ตอบ คุณต้องกำหนดค่าการตั้งค่าเหตุการณ์การโต้ตอบใน Chat API ดูขั้นตอนได้ที่ รับ และตอบกลับเหตุการณ์การโต้ตอบในเอกสารประกอบของ Chat API
- หากสร้างแอปใน Chat ด้วยการกำหนดค่าอัตโนมัติของ AppSheet ให้เผยแพร่แอปใน Chat โดยใช้ขั้นตอนที่อธิบายไว้ในเอกสารประกอบของ AppSheet แชร์ แอปใน Chat โดยใช้การกำหนดค่าอัตโนมัติ
แอปไดรฟ์
หากต้องการเผยแพร่แอปไดรฟ์ คุณต้องเปิดใช้และกำหนดค่า Google Drive API
เว็บแอป
หากต้องการเผยแพร่เว็บแอป คุณต้องระบุURL การนำทางสากล ซึ่งเป็น URL ที่ ชี้ไปยังเว็บแอปจากเมนูแอป Google
เว็บแอปต้องอยู่ในเวอร์ชันที่ใช้งานจริงและทำงานได้อย่างสมบูรณ์เมื่อกรอกข้อมูลในหน้าข้อมูลผลิตภัณฑ์ใน Store คุณต้องระบุไอคอนเพิ่มเติม ขนาด 96x96 และ 48x48 พิกเซล
หากสร้างเว็บแอปใน Apps Script ให้ทำตามขั้นตอนต่อไปนี้เพื่อรับ URL การนำทางสากล
- เปิดส่วนเสริม Google Workspace ในโปรแกรมแก้ไข Apps Script
- คลิกทําให้ใช้งานได้ > การทําให้ใช้งานได้ใหม่
- ในส่วน "เลือกประเภท" ให้คลิกเว็บแอป
- กรอกตัวเลือก แล้วคลิกติดตั้งใช้งาน
- คลิกคัดลอก
ระบุระดับการเข้าถึงที่แอปของคุณต้องการ
ในส่วนขอบเขต OAuth ให้ระบุรายการขอบเขต OAuth 2.0 ทั้งหมดที่แอปของคุณ ต้องการ ขอบเขต OAuth ที่คุณป้อนที่นี่ควรตรงกับสิ่งที่แสดงในหน้าจอคำยินยอม OAuth และไฟล์ Manifest ของ Apps Script (หากมี)
หากรวมการผสานรวมแอปมากกว่า 1 รายการ โปรดตรวจสอบว่าได้เพิ่มขอบเขตจาก แต่ละรายการลงในหน้าการกำหนดค่าแอป Marketplace SDK และ หน้าจอขอความยินยอม OAuth
ใช้ขอบเขตที่แคบที่สุดเท่าที่จะเป็นไปได้เสมอ (เช่น อย่ารวมขอบเขต Drive แบบเต็มหากคุณต้องการเพียงขอบเขตแบบอ่านอย่างเดียว)
สำหรับโปรเจ็กต์ Apps Script โปรดดูรายละเอียดเพิ่มเติมที่ขอบเขต การให้สิทธิ์
ให้ข้อมูลเกี่ยวกับนักพัฒนาแอป
ในส่วนข้อมูลนักพัฒนาแอป ให้กรอกข้อมูลติดต่อและรายละเอียดอื่นๆ ฟิลด์เหล่านี้จะปรากฏในหน้าข้อมูลผลิตภัณฑ์ใน Store ของแอป
ช่อง | |
---|---|
สถานะผู้ค้า |
เนื่องด้วยกฎหมายคุ้มครองผู้บริโภค เราต้องแจ้งให้ผู้บริโภคที่อยู่ในเขตเศรษฐกิจยุโรป (EEA) ทราบว่าผู้ขายในมาร์เก็ตเพลสเป็นผู้ค้าหรือไม่ใช่ผู้ค้า
หากไม่ได้ระบุ "ไม่ได้ระบุสถานะผู้ค้า" จะปรากฏใน ข้อมูลผลิตภัณฑ์ใน Store ของแอป |
ชื่อนักพัฒนาแอป | ชื่อที่จะแสดงเป็นผู้เขียนแอป หากคุณเป็นเทรดเดอร์ ให้ระบุชื่อทางการค้าหรือชื่อตามกฎหมาย |
ที่อยู่ทางไปรษณีย์ของนักพัฒนาแอป |
ต้องระบุสำหรับเทรดเดอร์ ไม่ได้รวบรวมสำหรับผู้ที่ไม่ใช่ผู้ค้า สถานที่ตั้งของธุรกิจ ป้อนที่อยู่ทางไปรษณีย์ที่ถูกต้องซึ่งใช้ติดต่อคุณได้ |
URL ของเว็บไซต์นักพัฒนาแอป | เว็บไซต์ที่อธิบายว่าคุณ (หรือองค์กรของคุณ) เป็น นักพัฒนาแอป |
อีเมลของนักพัฒนาแอป |
อีเมลที่จะใช้เป็นช่องทางการติดต่อ โดยจะไม่รวมอยู่ในข้อมูลแอป โปรดตรวจสอบว่าอีเมลนี้เป็นอีเมลปัจจุบัน เนื่องจากระบบจะใช้อีเมลนี้ในกรณีต่อไปนี้
|
URL เว็บไซต์ของแอปพลิเคชัน | ไม่บังคับ เว็บไซต์ที่อธิบายแอปของคุณเพิ่มเติม |
บันทึกการตั้งค่าการกำหนดค่าแอปใน SDK ของ Marketplace
ใช้ข้อมูลจากส่วนก่อนหน้า บันทึกการกำหนดค่าแอปใน Marketplace SDK โดยทำดังนี้
ในคอนโซล Google Cloud ให้ไปที่หน้าการกำหนดค่าแอปของ SDK ของ Marketplace โดยทำดังนี้
กรอกข้อมูลในแต่ละส่วนตามที่ระบุไว้ในส่วนก่อนหน้า
คลิกบันทึกฉบับร่าง
(ไม่บังคับ) คุณดูข้อมูลวิเคราะห์เกี่ยวกับการใช้งานแอปได้ใน Google Analytics โดยให้เพิ่มรหัส Google Analytics ใน Marketplace SDK
- ไปที่แท็บ Analytics
- ป้อนรหัส Google Analytics
- คลิกบันทึก
แก้ปัญหา
ส่วนนี้จะอธิบายปัญหาที่พบบ่อยที่คุณอาจพบ
ไม่มีสิทธิ์ที่จำเป็นเมื่อเผยแพร่แอปไปยัง Marketplace
คุณเผยแพร่แอปใน Marketplace ไม่ได้เนื่องจาก ความพยายามในการกำหนดค่าแอปพลิเคชันในหน้าการกำหนดค่าแอปของ Marketplace SDK ล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดต่อไปนี้
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 อย่างปลอดภัย ถือว่าแนวทางปฏิบัตินี้ไม่ดีเนื่องจากจำกัดสิทธิ์เข้าถึงระดับแก้ไข ไปยังทรัพยากรอื่นๆ ในโปรเจ็กต์ได้ยาก