ขั้นตอนในการสร้างปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูลมีดังนี้
- สร้างโปรเจ็กต์ Apps Script ใหม่
- เขียนรหัสเครื่องมือเชื่อมต่อ
- กรอกไฟล์ Manifest ของโปรเจ็กต์ให้เสร็จสมบูรณ์
สร้างโปรเจ็กต์ Apps Script ใหม่
ไปที่ Google Apps Script เพื่อสร้างโปรเจ็กต์ใหม่ Apps Script จะสร้างสคริปต์เริ่มต้นให้คุณ คุณสามารถนำฟังก์ชัน myFunction
ออกและเปลี่ยนชื่อโปรเจ็กต์ได้ (ดูข้อมูลเพิ่มเติมเกี่ยวกับ Apps Script)
เขียนรหัสเครื่องมือเชื่อมต่อ
เครื่องมือเชื่อมต่อทั้งหมดจำเป็นต้องมีชุดฟังก์ชันเฉพาะที่กำหนดไว้ แอปพลิเคชันที่โฮสต์ (เช่น Looker Studio) จะเรียกใช้ฟังก์ชันเหล่านี้ เครื่องมือเชื่อมต่อของคุณควรจัดการคำขอที่เข้ามาใหม่และตอบกลับตามที่อธิบายไว้ในเอกสารอ้างอิง API เครื่องมือเชื่อมต่อชุมชน หากพบปัญหาขณะพัฒนาโค้ด โปรดอ่านคู่มือแก้ไขข้อบกพร่องเพื่อรับความช่วยเหลือ
กำหนดประเภทการตรวจสอบสิทธิ์ใน getAuthType()
เราจะเรียกใช้ฟังก์ชันนี้เพื่อระบุวิธีการตรวจสอบสิทธิ์ที่ใช้สำหรับบริการของบุคคลที่สาม โปรดดูรายละเอียดในข้อมูลอ้างอิง getAuthType() วิธีการตรวจสอบสิทธิ์ที่รองรับในปัจจุบันจะแสดงอยู่ในข้อมูลอ้างอิง AuthType
ตัวอย่างเช่น เครื่องมือเชื่อมต่อต่อไปนี้ไม่จำเป็นต้องมีการตรวจสอบสิทธิ์
หากแหล่งข้อมูลต้องมีการตรวจสอบสิทธิ์ OAuth 2.0 ให้ดูคู่มือการตรวจสอบสิทธิ์ OAuth 2.0 และเพิ่มฟังก์ชันที่จำเป็นเพิ่มเติมให้กับเครื่องมือเชื่อมต่อ
กำหนดการกำหนดค่าผ่าน getConfig()
ระบบจะเรียกใช้ฟังก์ชัน getConfig()
เพื่อรับการกำหนดค่าสำหรับเครื่องมือเชื่อมต่อ รวมถึงค่าที่ผู้ใช้ให้ไว้ซึ่งเครื่องมือเชื่อมต่อต้องใช้ ดูรายละเอียดได้จากข้อมูลอ้างอิงของ getConfig()
Looker Studio จะแสดงผลหน้าจอการกำหนดค่าเครื่องมือเชื่อมต่อโดยอิงตามการตอบสนองของ getConfig()
องค์ประกอบการกำหนดค่าที่รองรับแสดงอยู่ในการอ้างอิง ConfigType
หากแหล่งข้อมูลต้องใช้วันที่เป็นพารามิเตอร์ ให้เรียกใช้ config.setDateRangeRequired(true) หากคุณต้องถามคำถามเกี่ยวกับการกำหนดค่าแบบมีเงื่อนไขหรือแบบไดนามิก โปรดดูการกำหนดค่าแบบขั้นบันได
ต่อไปนี้เป็นตัวอย่างของเครื่องมือเชื่อมต่อที่กำหนดให้ผู้ใช้ป้อนโค้ดชื่อแพ็กเกจ npm ข้อมูลและช่องป้อนข้อมูลจะกำหนดไว้ในฟังก์ชัน getConfig()
ดังนี้
กำหนดช่องด้วย getSchema()
โดยจะเรียกฟังก์ชันนี้เพื่อรับสคีมาสำหรับคำขอนั้นๆ พารามิเตอร์การกําหนดค่าที่ฟังก์ชัน getConfig()
กําหนดจะอยู่ในอาร์กิวเมนต์ request
ดูรายละเอียดได้ที่ข้อมูลอ้างอิงของ getSchema()
สคีมาอาจได้รับการแก้ไขหรือคุณอาจต้องระบุแบบไดนามิกเมื่อได้รับคำขอ ทั้งนี้ขึ้นอยู่กับแหล่งข้อมูลของเครื่องมือเชื่อมต่อและการกำหนดค่าที่ผู้ใช้ให้ไว้
เช่น ถ้าเครื่องมือเชื่อมต่อดึงข้อมูลรายงานตามรหัสรายงาน ข้อมูลที่แสดงผลสำหรับรายงานนั้นจึงอาจไม่ทราบสคีมาก่อน
ในกรณีนี้ getSchema()
อาจต้องมีการดึงข้อมูลและจะต้องมีการคำนวณสคีมา
ดึงและแสดงผลข้อมูลด้วย getData()
โดยจะเรียกฟังก์ชันนี้เพื่อรับข้อมูลสำหรับคำขอนั้นๆ ระบบจะระบุพารามิเตอร์การกำหนดค่าที่ฟังก์ชัน getConfig()
กำหนดไว้ในอาร์กิวเมนต์ request
ดูรายละเอียดได้ที่ข้อมูลอ้างอิงของ getData()
พารามิเตอร์ต่อไปนี้จากคำขอ getData()
ต้องการการดำเนินการเพิ่มเติม
lastRefresh
lastRefresh
แสดงถึงการประทับเวลาที่ระบุเวลาของคำขอให้รีเฟรชข้อมูลครั้งล่าสุด คุณควรแยกวิเคราะห์ค่าด้วยnew Date(timestampString)
ได้ หากใช้บริการแคช Apps Script หรือวิธีการแคชอื่นๆ การประทับเวลาlastRefresh
จะช่วยให้คุณระบุได้ว่าจะส่งคำขอดึงข้อมูลใหม่ไปยังแหล่งข้อมูลหรือแสดงข้อมูลจากแคชdateRange
หากตั้งค่าdateRangeRequired
เป็นtrue
ในgetConfig()
การโทรgetData()
แต่ละครั้งจะมีช่วงวันที่ที่เลือกในคำขอ ดูรายละเอียดเพิ่มเติมในการใช้ช่วงวันที่
ตัวอย่างต่อไปนี้จะดึงข้อมูลโดยอิงตามคำขอขาเข้าและแสดงผลสถิติของแพ็กเกจ
สร้างไฟล์ Manifest ของโปรเจ็กต์ให้เสร็จสมบูรณ์
ไฟล์ Manifest มีข้อมูลเกี่ยวกับปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูล ซึ่งจำเป็นสำหรับการทำให้เครื่องมือเชื่อมต่อใช้งานได้และใช้เครื่องมือเชื่อมต่อใน Looker Studio
หากต้องการแก้ไขไฟล์ Manifest ในสภาพแวดล้อมการพัฒนาสคริปต์ Apps ให้คลิกเมนูมุมมอง และคลิกแสดงไฟล์ Manifest ระบบจะสร้างไฟล์ Manifest appsscript.json
ใหม่
อัปเดตไฟล์ Manifest ให้มีข้อมูลต่อไปนี้
โปรดดูรายละเอียดเกี่ยวกับไฟล์ Manifest ของ Looker Studio ที่หัวข้อข้อมูลอ้างอิงไฟล์ Manifest
ขั้นตอนถัดไป
ขั้นตอนต่อไปคือการทำให้ปลั๊กอินจากชุมชนสำหรับใช้ลิงก์ข้อมูลใช้งานได้