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

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

ข้อควรระวัง: ข้อมูลใดก็ตามที่คุณใส่ในไฟล์ Manifest ควรได้รับการพิจารณาว่า เป็นข้อมูลสาธารณะ

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 ค่าควรเป็นรหัสรายงานของรายงาน Data Studio ที่จะใช้เป็นเทมเพลต ดูคำแนะนำเกี่ยวกับการระบุ เทมเพลตรายงาน
forceViewersCredentials	boolean	ควรกำหนดให้ใช้ข้อมูลเข้าสู่ระบบของผู้ดูสำหรับแหล่งข้อมูลที่สร้างจากเครื่องมือเชื่อมต่อนี้หรือไม่ พร็อพเพอร์ตี้นี้เป็นค่าที่ไม่บังคับและมีค่าเริ่มต้นเป็น false ดูรายละเอียดเพิ่มเติมเกี่ยวกับข้อมูลเข้าสู่ระบบของผู้ดูได้ที่ข้อมูล เข้าสู่ระบบของแหล่งข้อมูล
useQueryConfig	boolean	เลิกใช้งานแล้ว: ตัวเชื่อมต่อนี้จะแสดงผลการกำหนดค่าการค้นหาสำหรับ `getData()` หรือไม่ โปรดใช้ `advancedServices` แทน
advancedServices.data	boolean	ไม่ว่าจะมีการกำหนดค่าการค้นหาสำหรับ `getData()` หรือไม่ โปรดดูบริการขั้นสูง
advancedServices.schema	boolean	ไม่ว่าจะส่งคืนการกำหนดค่าการค้นหาสำหรับ `getSchema()` หรือไม่ โปรดดูบริการ ขั้นสูง
ไม่บังคับ (พร็อพเพอร์ตี้ระดับรูท)
urlFetchWhitelist	list(string)	รายการคำนำหน้า URL ของ HTTPS ที่ตัวเชื่อมต่อใช้ ปลายทาง 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	ระบุว่าผู้ใช้จะต้องชำระเงินเพื่อใช้เครื่องมือเชื่อมต่อ

แหล่งที่มา

แหล่งที่มาคือรายการการแจงนับสำหรับแหล่งที่มา คุณดูรายการแหล่งข้อมูลที่มีอยู่ได้ที่ที่เก็บรีจิสทรีข้อมูล หากแหล่งข้อมูลที่คุณเชื่อมต่อ ไม่มีอยู่ในที่เก็บ ให้ส่งPull Request ไปยังที่เก็บ Data Registry เพื่อเพิ่มแหล่งข้อมูล ชื่อแหล่งข้อมูลต้องมีเฉพาะอักขระตัวพิมพ์ใหญ่และขีดล่าง (เช่น Google Analytics จะเป็น GOOGLE_ANALYTICS) ในไฟล์ Manifest ของ Community Connector ให้ใช้ value ของพร็อพเพอร์ตี้รหัสแหล่งข้อมูล เช่น GOOGLE_ANALYTICS

ตัวอย่างไฟล์ Manifest สำหรับ Community Connector

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

data-studio/appsscript.json

ดูใน GitHub

{
  "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/"]
}