ข้อกำหนดเครื่องมือเชื่อมต่อพาร์ทเนอร์

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

Apps Script

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

1. แชร์สิทธิ์ดูโปรเจ็กต์ Apps Script ของคุณกับรายการต่อไปนี้
   • [e-mail]
   • [e-mail]
2. สร้างการทำให้ใช้งานได้ชื่อ Production และอัปเดตการติดตั้งใช้งาน Production ให้เป็นเวอร์ชันของโค้ดที่คุณตั้งใจจะเผยแพร่
3. ยืนยันว่าคุณได้อัปเดตการทำให้ใช้งานได้ของ Production เป็นเวอร์ชันของโค้ดที่ต้องการตรวจสอบแล้ว
4. ยืนยันว่าไฟล์ Manifest แสดงใน Apps Script คลิกการตั้งค่าโปรเจ็กต์ ทางด้านซ้าย เลือกช่องทำเครื่องหมายแสดงไฟล์ Manifest "appsscript.json" ในเครื่องมือแก้ไข

ไฟล์ Manifest

ใส่ข้อมูลต่อไปนี้ในไฟล์ Manifest ของเครื่องมือเชื่อมต่อและยืนยันว่าโปรเจ็กต์ Apps Script ของคุณได้รับการกำหนดค่าให้แสดงไฟล์ Manifest appsscript.json ในตัวแก้ไข

ดูข้อมูลอ้างอิงไฟล์ Manifest ของเครื่องมือเชื่อมต่อชุมชนสำหรับข้อมูลเพิ่มเติม

dataStudio

1. description ควรให้ข้อมูลและวิธีการเพื่อความเข้าใจขั้นพื้นฐานเกี่ยวกับเครื่องมือเชื่อมต่อและวิธีการใช้งาน เครื่องมือเชื่อมต่อที่มีคำอธิบายคลุมเครือและไม่สมบูรณ์จะถูกปฏิเสธ
2. addOnUrl ควรเป็นหน้าที่โฮสต์ไว้โดยเฉพาะเกี่ยวกับเครื่องมือเชื่อมต่อของคุณ โดยแนะนำให้โฮสต์บนโดเมนของคุณ หน้าเว็บต้องมีข้อมูลต่อไปนี้
   • นโยบายความเป็นส่วนตัวและข้อกำหนดในการใช้งานหรือลิงก์ไปยังเนื้อหานี้ในโดเมนเดียวกับ addOnUrl
   • รายละเอียดที่ผู้ใช้จำเป็นต้องทราบเพื่อใช้เครื่องมือเชื่อมต่อของคุณ
   • ลิงก์ลงชื่อสมัครใช้ ถ้าต้องมีบัญชีเพื่อใช้เครื่องมือเชื่อมต่อของคุณ
   • เนื้อหาควรโฮสต์ในโดเมนของคุณ ไม่อนุญาตให้โฮสต์บน https://sites.google.com/
   • ดูตัวอย่างหน้าเว็บจากพาร์ทเนอร์ที่มีอยู่ ได้แก่ Funnel, Supermetric, CallRail
3. supportUrl ควรเป็นหน้าที่โฮสต์เพื่อรับการสนับสนุนสำหรับเครื่องมือเชื่อมต่อของคุณ ต้องไม่ใช่อีเมลหรือลิงก์ mailto
4. logoUrl ควรชี้ไปยังภาพนิ่งที่โฮสต์ภายใต้การควบคุมของคุณ คุณไม่สามารถใช้รูปภาพที่ได้รับจากบริการของ Google ในโดเมนต่างๆ เช่น *.gstatic.com, *.ggpht.com, *.google.com, *.googleusercontent.com การใช้ Google Cloud Storage เพื่อแสดงรูปภาพจากโดเมน *.googleapis.com เป็นสิ่งที่ยอมรับได้และเป็นตัวเลือกที่แนะนำสำหรับการโฮสต์
   • ระบบจะปฏิเสธเครื่องมือเชื่อมต่อที่มีไอคอนเคลื่อนไหว ใช้ภาพนิ่ง
   • เราขอแนะนำให้ใช้รูปภาพขนาด 48x48 พิกเซลเป็นอย่างน้อย
   • หลีกเลี่ยงรูปภาพที่มีเฉพาะข้อความซึ่งอ่านยากเมื่อลดขนาดเป็น 48x48 พิกเซล
5. ป้อนข้อมูลพร็อพเพอร์ตี้ sources ด้วยแหล่งที่มาทั้งหมดที่เครื่องมือเชื่อมต่อเชื่อมต่อ ดูรายละเอียดได้ที่แหล่งที่มาในข้อมูลอ้างอิงไฟล์ Manifest
   • คุณดูรายการแหล่งที่มาที่มีอยู่ได้ที่ที่เก็บรีจิสทรีข้อมูล หากต้นทางที่คุณเชื่อมต่อไม่มีอยู่ในที่เก็บ ให้ส่งคำขอแบบพุลไปยังที่เก็บรีจิสทรีข้อมูลเพื่อเพิ่มต้นทาง เครื่องมือเชื่อมต่อจะทำการตรวจสอบไม่สำเร็จหากไม่มีแหล่งที่มาในไฟล์ Manifest ในที่เก็บ
   • นี่เป็นข้อมูลเมตาเพิ่มเติมสำหรับเครื่องมือเชื่อมต่อที่จะจัดทำดัชนีสำหรับฟีเจอร์การค้นหาในแกลเลอรี เครื่องมือเชื่อมต่อจะปรากฏในผลการค้นหาเมื่อผู้ใช้ค้นหาแหล่งที่มาที่เจาะจงในแกลเลอรี
6. ระบุค่าสำหรับshortDescription, authType, feeType, privacyPolicyUrl และ termsOfServiceUrl
7. name ควรแสดงถึงวัตถุประสงค์ของเครื่องมือเชื่อมต่อโดยตรง ชื่อที่ชัดเจนจะช่วยให้ผู้ใช้พิจารณาว่าเครื่องมือเชื่อมต่อของคุณตรงตามความต้องการหรือไม่ หลีกเลี่ยงการใช้คำว่าเครื่องมือเชื่อมต่อในชื่อเนื่องจากผู้ใช้ทราบอยู่แล้วว่าตนกำลังดูเครื่องมือเชื่อมต่ออยู่
   • อย่าใช้สัญลักษณ์พิเศษหรือสัญลักษณ์ที่มองไม่เห็นโดยมีเจตนาให้คนสนใจหรืออาจเปลี่ยนตำแหน่งของเครื่องมือเชื่อมต่อ
8. อย่าใช้ชื่อย่อสำหรับ Looker Studio ในทุกที่ในไฟล์ Manifest (เช่น GDS, DS เป็นต้น)
9. ไม่อนุญาตให้ใช้อีโมจิในช่อง Manifest ทุกช่อง (description, shortDescription, name ฯลฯ) โดยทั่วไป อย่าใส่อักขระพิเศษหรือสัญลักษณ์พิเศษที่ดูไม่ได้โดยมีเจตนาดึงความสนใจ ไปยังเครื่องมือเชื่อมต่อของคุณ
10. หากเครื่องมือเชื่อมต่อมีสคีมาแบบคงที่ ให้สร้างเทมเพลตรายงานสำหรับเครื่องมือเชื่อมต่อแล้วเพิ่มลงในไฟล์ Manifest เปิดใช้การแชร์ด้วยลิงก์สำหรับรายงาน
    

urlFetchWhitelist

1. จำกัดจำนวนปลายทางที่ UrlFetchApp เรียกใช้ไว้เป็นจำนวนปลายทางที่จำเป็นสำหรับฟังก์ชันการทำงานของเครื่องมือเชื่อมต่อ เพิ่มพร็อพเพอร์ตี้ urlFetchWhitelist ลงในระดับรากของไฟล์ Manifest ดูข้อมูลอ้างอิง urlFetchรายการที่อนุญาต สำหรับข้อมูลเพิ่มเติม
   
   • รวมปลายทางทั้งหมดที่ใช้กับบริการ UrlFetchApp
   • หากเครื่องมือเชื่อมต่อไม่ดึงทรัพยากรโดยใช้บริการ UrlFetchApp ให้ตั้งค่า urlFetchWhitelist เป็นรายการที่ว่างเปล่า []
   • หากเครื่องมือเชื่อมต่อไม่ได้เชื่อมต่อกับชุดปลายทางแบบคงที่หรือคำนำหน้าปลายทางแตกต่างกันไป ให้ข้ามพร็อพเพอร์ตี้ urlFetchWhitelist และระบุรายละเอียดในช่องข้อยกเว้นสำหรับ urlFetchWhitelist เมื่อส่งคำขอรับการตรวจสอบ

oauthScopes

1. กำหนดขอบเขต OAuth ที่ชัดเจนในไฟล์ Manifest เครื่องมือเชื่อมต่อที่ไม่มีขอบเขต OAuth ที่ชัดเจนจะถูกปฏิเสธ

ตัวเชื่อม

1. หากผู้ใช้ต้องมีบัญชีเพื่อใช้เครื่องมือเชื่อมต่อ โปรดตรวจสอบว่าเครื่องมือเชื่อมต่อ description หรือลิงก์ addOnUrl มีวิธีที่จะช่วยผู้ใช้สร้างบัญชี
2. เครื่องมือเชื่อมต่อต้องไม่อยู่ในสถานะยังไม่เสร็จสมบูรณ์หรือเบต้า คุณต้องเผยแพร่เครื่องมือเชื่อมต่อ ที่สมบูรณ์และใช้งานได้ คุณอัปเดตเครื่องมือเชื่อมต่อได้ทุกเมื่อ แต่การใช้งานเวอร์ชันที่ใช้งานจริงที่เปิดตัวแก่ผู้ใช้ควรได้รับการทดสอบและมีฟีเจอร์ครบถ้วน
3. แสดงข้อความแสดงข้อผิดพลาดที่มีความหมายและดำเนินการแก้ไขได้เมื่อผู้ใช้พบข้อผิดพลาดภายในของเครื่องมือเชื่อมต่อ ซึ่งรวมถึงกรณีที่ผู้ใช้ป้อนข้อมูลที่ไม่ถูกต้อง/ไม่มีข้อมูลในการกำหนดค่า
4. shortDescription, description, ลิงก์ addOnUrl, ลิงก์ supportUrl และหน้า OAuth (หากมี) ไม่ควรมีข้อผิดพลาดด้านการสะกดและไวยากรณ์
5. shortDescription ไม่สามารถมี URL ได้
6. ใช้วิธีการตรวจสอบสิทธิ์ที่ getAuthType() มีให้ อย่าขอข้อมูลเข้าสู่ระบบผ่าน getConfig()
   
7. ทำตามขั้นตอนการยืนยันไคลเอ็นต์ OAuth ให้เสร็จสมบูรณ์ การยืนยันเป็นการดำเนินการที่จำเป็นสำหรับเครื่องมือเชื่อมต่อทั้งหมด ไม่ว่าวิธีการตรวจสอบสิทธิ์ใน getAuthType() จะเป็นวิธีใดก็ตาม กระบวนการยืนยันเป็นคนละกระบวนการกับการตรวจสอบเครื่องมือเชื่อมต่อและจะจัดการโดยทีมที่แยกต่างหาก ไม่ใช่ Looker Studio ดูข้อมูลเพิ่มเติมที่คำถามที่พบบ่อยเกี่ยวกับการตรวจสอบ OAuth API เครื่องมือเชื่อมต่อของคุณจะถูกปฏิเสธหากกระบวนการยืนยันไคลเอ็นต์ OAuth ไม่เสร็จสมบูรณ์
   
   • ระหว่างกระบวนการยืนยัน OAuth ให้เพิ่มขอบเขต OAuth ที่จำเป็นของเครื่องมือเชื่อมต่อโดยเป็นส่วนหนึ่งของการกำหนดค่าหน้าจอคำยินยอม OAuth หากไม่เพิ่มขอบเขตที่จำเป็นทั้งหมด คุณอาจผ่านกระบวนการยืนยัน OAuth แต่เครื่องมือเชื่อมต่อจะยังคงแสดงหน้าจอแอปที่ยังไม่ได้รับการยืนยัน ซึ่งจะทำให้ขั้นตอนการยืนยันเครื่องมือเชื่อมต่อล้มเหลว
     ให้สิทธิ์และทดสอบเครื่องมือเชื่อมต่อโดยใช้บัญชีใหม่หลังจากผ่านกระบวนการยืนยัน OAuth แล้ว เพื่อให้มั่นใจว่าหน้าจอแอปที่ไม่ได้รับการยืนยันจะไม่แสดงให้ผู้ใช้เห็น
8. ตรวจสอบว่าคุณปฏิบัติตามข้อกำหนดในการให้บริการแกลเลอรีของ Looker Studio (ผู้ส่ง)

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

เผยแพร่ เครื่องมือเชื่อมต่อพาร์ทเนอร์