ไฟล์ Manifest (appsscript.json
) เป็นไฟล์ JSON ในโปรเจ็กต์เครื่องมือเชื่อมต่อ Apps Script ซึ่งประกอบด้วยข้อมูลบางอย่างเกี่ยวกับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล ซึ่งจำเป็นสำหรับการติดตั้งใช้งานและใช้เครื่องมือเชื่อมต่อใน Looker Studio อ่านเพิ่มเติมเกี่ยวกับไฟล์ Manifest ใน Apps Script
ไฟล์ Manifest ของคุณควรมีข้อมูลต่อไปนี้
ชื่อพร็อพเพอร์ตี้ | Type | คำอธิบาย |
---|---|---|
ต้องระบุ (ภายใต้พร็อพเพอร์ตี้ dataStudio )
|
||
name
|
string
|
ชื่อของเครื่องมือเชื่อมต่อ จำกัดสูงสุด 28 อักขระ |
company
|
string
|
ชื่อองค์กรหรือนักพัฒนาแอป |
companyUrl
|
string (link)
|
ลิงก์ไปยังเว็บไซต์ขององค์กรหรือนักพัฒนาแอป |
logoUrl
|
string (image link)
|
URL ไปยังไอคอนสำหรับเครื่องมือเชื่อมต่อของคุณ ขนาดที่ต้องการคือ 40 x 40 พิกเซล |
addOnUrl
|
string (link)
|
ลิงก์ไปยังหน้า "ดูข้อมูลเพิ่มเติม" โดยเฉพาะ ซึ่งควรอธิบายว่าเครื่องมือเชื่อมต่อทำอะไรบ้างและข้อมูลที่เครื่องมือเชื่อมต่อเข้าถึง คุณควรโฮสต์และดูแลหน้านี้ หน้านี้ต้องมีหรือลิงก์ไปยังข้อกำหนดในการให้บริการและนโยบายความเป็นส่วนตัว |
supportUrl
|
string (link)
|
ลิงก์ไปยังหน้าการสนับสนุนเพื่อรองรับเครื่องมือเชื่อมต่อนี้ ผู้ใช้ควรรายงานปัญหาเกี่ยวกับเครื่องมือเชื่อมต่อของคุณได้ที่ลิงก์นี้ คุณควรโฮสต์และดูแลหน้านี้ |
description
|
string
|
คำอธิบายสำหรับเครื่องมือเชื่อมต่อของคุณ ผู้ใช้จะเห็นคำอธิบายทั้งหมดในหน้าการกำหนดค่าเครื่องมือเชื่อมต่อ ลิงก์ต่างๆ จะคลิกได้ |
ไม่บังคับ (ใต้พร็อพเพอร์ตี้ dataStudio )
|
||
shortDescription
|
string
|
จำกัด: 114 อักขระ หากเผยแพร่เครื่องมือเชื่อมต่อแล้ว คำอธิบายสั้นๆ นี้จะปรากฏในการ์ดแกลเลอรีสำหรับเครื่องมือเชื่อมต่อของคุณ ใช้สิ่งนี้เพื่ออธิบายคร่าวๆ ว่าเครื่องมือเชื่อมต่อของคุณทำอะไร ผู้ใช้จะดูข้อมูลนี้ได้เมื่อเรียกดูเครื่องมือเชื่อมต่อในแกลเลอรี |
privacyPolicyUrl
|
string (link)
|
ลิงก์ไปยังนโยบายความเป็นส่วนตัวสำหรับเครื่องมือเชื่อมต่อ / องค์กรนักพัฒนาซอฟต์แวร์ |
termsOfServiceUrl
|
string (link)
|
ลิงก์ไปยังข้อกำหนดในการให้บริการของเครื่องมือเชื่อมต่อ / องค์กรนักพัฒนาซอฟต์แวร์ |
authType
|
list(AuthType)
|
ประเภทวิธีการตรวจสอบสิทธิ์สำหรับเครื่องมือเชื่อมต่อของคุณ โปรดดู AuthType ด้านล่าง |
feeType
|
list(FeeType)
|
ระบุประเภทค่าธรรมเนียมสำหรับเครื่องมือเชื่อมต่อของคุณ โปรดดู FeeType ด้านล่าง |
sources
|
list(Sources)
|
รายการแหล่งข้อมูลที่เครื่องมือเชื่อมต่อนี้เชื่อมต่อได้ ดูแหล่งที่มาด้านล่าง |
templates
|
Object
|
รายการเทมเพลตที่สามารถใช้กับเครื่องมือเชื่อมต่อนี้ รองรับเทมเพลตเริ่มต้นเพียง 1 รายการเท่านั้นที่ระบุโดยการตั้งค่าคีย์ default ค่านี้ควรเป็นรหัสรายงานสำหรับรายงาน Looker Studio ที่จะใช้เป็นเทมเพลต ดูคำแนะนำเกี่ยวกับการให้เทมเพลตรายงาน
|
forceViewersCredentials
|
boolean
|
กำหนดว่าควรบังคับใช้ข้อมูลเข้าสู่ระบบของผู้ดูสำหรับแหล่งข้อมูลที่สร้างขึ้นจากเครื่องมือเชื่อมต่อนี้หรือไม่ พร็อพเพอร์ตี้นี้เป็นแบบไม่บังคับและมีค่าเริ่มต้นเป็น false ดูรายละเอียดเพิ่มเติมเกี่ยวกับข้อมูลเข้าสู่ระบบของผู้ดูได้ที่ข้อมูลเข้าสู่ระบบของแหล่งข้อมูล
|
useQueryConfig
|
boolean
|
เลิกใช้งานแล้ว: เครื่องมือเชื่อมต่อนี้จะส่งคืนการกำหนดค่าการค้นหาสำหรับ "getData()" หรือไม่ โปรดใช้ "advancedServices" แทน |
advancedServices.data
|
boolean
|
เครื่องมือเชื่อมต่อนี้จะส่งคืนการกำหนดค่าการค้นหาสำหรับ "getData()" หรือไม่ โปรดดูบริการขั้นสูง |
advancedServices.schema
|
boolean
|
เครื่องมือเชื่อมต่อนี้จะส่งคืนการกำหนดค่าการค้นหาสำหรับ "getSchema()" หรือไม่ โปรดดูบริการขั้นสูง |
ไม่บังคับ (พร็อพเพอร์ตี้ระดับราก) | ||
urlFetchWhitelist
|
list(string)
|
รายการคำนำหน้า HTTPS URL ที่เครื่องมือเชื่อมต่อใช้ ปลายทางของ URL ที่ดึงข้อมูลต้องตรงกับคำนำหน้าหนึ่งในรายการนี้ การดำเนินการนี้จะช่วย ปกป้องข้อมูลผู้ใช้ได้ ดูรายละเอียดเพิ่มเติมใน URL ของรายการที่อนุญาต |
AuthType
ค่าสำหรับประเภทวิธีการตรวจสอบสิทธิ์อาจเป็นค่าใดค่าหนึ่งต่อไปนี้
ค่า enum | คำอธิบาย |
---|---|
NONE
|
แสดงว่าเครื่องมือเชื่อมต่อไม่จำเป็นต้องมีการตรวจสอบสิทธิ์ |
OAUTH2 |
ระบุว่าเครื่องมือเชื่อมต่อใช้ OAuth 2.0 |
KEY |
ระบุว่าเครื่องมือเชื่อมต่อใช้คีย์ API |
USER_PASS |
ระบุว่าเครื่องมือเชื่อมต่อใช้ชื่อผู้ใช้/รหัสผ่าน |
USER_TOKEN |
ระบุว่าเครื่องมือเชื่อมต่อใช้ชื่อผู้ใช้/โทเค็น |
PATH_USER_PASS |
ระบุว่าเครื่องมือเชื่อมต่อใช้เส้นทาง/ชื่อผู้ใช้/รหัสผ่าน |
PATH_KEY |
ระบุว่าเครื่องมือเชื่อมต่อใช้เส้นทาง/คีย์ |
FeeType
ค่าสำหรับประเภทค่าธรรมเนียมอาจเป็นค่าใดก็ได้ต่อไปนี้
ค่า enum | คำอธิบาย |
---|---|
FREE |
บ่งบอกว่าเครื่องมือเชื่อมต่อใช้งานได้ฟรี |
FREE_TRIAL |
บ่งบอกว่าเครื่องมือเชื่อมต่อมีตัวเลือกช่วงทดลองใช้ฟรี |
PAID |
ระบุว่าผู้ใช้ต้องชำระเงินเพื่อใช้เครื่องมือเชื่อมต่อ |
แหล่งข้อมูล
แหล่งที่มาคือรายการของ enum สำหรับแหล่งที่มา ดูรายชื่อแหล่งที่มาที่มีอยู่ได้ที่ที่เก็บรีจิสทรีข้อมูล หากต้นทางที่คุณเชื่อมต่อไม่มีอยู่ในที่เก็บ ให้ส่งคำขอแบบพุลไปยังที่เก็บรีจิสทรีข้อมูลเพื่อเพิ่มต้นทาง ชื่อแหล่งที่มามีได้เฉพาะอักขระตัวพิมพ์ใหญ่และขีดล่างเท่านั้น (เช่น Google Analytics จะเป็น GOOGLE_ANALYTICS
)
ในไฟล์ Manifest ของปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล ให้ใช้ค่าของพร็อพเพอร์ตี้รหัสแหล่งข้อมูล เช่น GOOGLE_ANALYTICS
ตัวอย่างไฟล์ Manifest สำหรับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล
ต่อไปนี้เป็นตัวอย่างของไฟล์ Manifest ที่สมบูรณ์