การอ้างอิงไฟล์ Manifest

ไฟล์ Manifest (appsscript.json) เป็นไฟล์ JSON ในเครื่องมือเชื่อมต่อ Apps Script ผลการค้นหานี้มีข้อมูลบางอย่างเกี่ยวกับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล ที่จำเป็นต่อการทำให้ใช้งานได้และใช้เครื่องมือเชื่อมต่อใน Looker Studio อ่านเพิ่มเติม เกี่ยวกับไฟล์ Manifest ใน Apps Script

ไฟล์ Manifest ของคุณควรมีข้อมูลต่อไปนี้

ชื่อพร็อพเพอร์ตี้ ประเภท คำอธิบาย
ต้องระบุ (ภายใต้พร็อพเพอร์ตี้ 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 รายการเทมเพลตที่สามารถใช้กับเครื่องมือเชื่อมต่อนี้ ค่าเริ่มต้นเพียงรายการเดียว เทมเพลตได้รับการสนับสนุน ซึ่งระบุโดยการตั้งค่า 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 สำหรับแหล่งที่มา คุณสามารถดูรายการที่มีอยู่ของ แหล่งข้อมูลที่ที่เก็บข้อมูลรีจิสทรีของเรา หากต้นทางที่คุณกำลังเชื่อมต่อ ไม่มีอยู่ในที่เก็บ ให้ส่งคำขอพุลไปยัง Data Registry ที่เก็บเพื่อเพิ่มแหล่งที่มา ชื่อแหล่งที่มามีได้เฉพาะตัวพิมพ์ใหญ่เท่านั้น อักขระและขีดล่าง (เช่น Google Analytics จะเป็น GOOGLE_ANALYTICS) ในไฟล์ Manifest ของปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล ให้ใช้ค่าของรหัสแหล่งข้อมูล พร็อพเพอร์ตี้ เช่น GOOGLE_ANALYTICS

ตัวอย่างไฟล์ Manifest ของปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล

ต่อไปนี้คือตัวอย่างของไฟล์ Manifest ที่สมบูรณ์

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}