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