השלבים לבניית מחבר קהילה הם:
- עליך ליצור פרויקט חדש ב-Apps Script.
- כותבים את קוד המחבר.
- משלימים את קובץ המניפסט של הפרויקט.
יצירת פרויקט חדש ב-Apps Script
כדי ליצור פרויקט חדש, צריך להיכנס אל Google Apps Script. Apps Script ייצור בשבילכם סקריפט ברירת מחדל. אתם יכולים להסיר את הפונקציה myFunction
ולשנות את שם הפרויקט. (למידע נוסף על Apps Script)
כתיבת קוד המחבר
כל מחבר נדרש להגדרה של קבוצה ספציפית של פונקציות. האפליקציה המארחת (למשל Looker Studio) תפעיל את הפונקציות האלה. המחבר שלך מצופה לטפל בבקשות נכנסות ולהגיב כפי שמתואר בחומר העזר בנושא Community Connector API. אם נתקלתם בבעיות במהלך פיתוח הקוד, קראו את המדריך לניפוי באגים לקבלת עזרה.
הגדרת סוג אימות ב-getAuthType()
הפונקציה הזו נקראת כדי לזהות את שיטת האימות שמשמשת
לשירות של צד שלישי. לפרטים נוספים, אפשר לעיין בחומר העזר בנושא getAuthType(). שיטות האימות שנתמכות כרגע מפורטות בAuthType
קובצי עזר.
לדוגמה, המחבר הבא לא דורש אימות:
אם מקור הנתונים דורש אימות OAuth 2.0, עיינו במדריך לאימות OAuth 2.0 והוסיפו את הפונקציות הנדרשות הנוספות למחבר.
קביעת ההגדרות באמצעות getConfig()
הפונקציה getConfig()
מופעלת כדי לקבל את התצורה של המחבר, כולל הערכים שסופקו על ידי משתמשים שדרושים למחבר. לפרטים נוספים, ראו getConfig()
.
בהתאם לתגובה של getConfig()
, Looker Studio יעבד את מסך ההגדרות של המחבר. רכיבי התצורה הנתמכים מפורטים בחומר עזר בנושא ConfigType
.
אם צריך להגדיר תאריך בתור פרמטר במקור הנתונים, צריך לקרוא לפונקציה config.setDateRangeRequired(true). אם צריך לשאול שאלות לגבי הגדרה מותנית או דינמית, כדאי לעיין בהגדרה מדורגת.
דוגמה למחבר שדורש מהמשתמש להזין קוד שם של חבילה של npm. הפרטים ושדה קלט מוגדרים בפונקציה getConfig()
:
הגדרת השדות באמצעות getSchema()
הפונקציה הזו נקראת כדי לקבל את הסכימה של הבקשה הנתונה. כל הפרמטרים של הגדרה שמוגדרים על ידי הפונקציה getConfig()
יסופקו בארגומנט request
. פרטים נוספים זמינים בחומר עזר בנושא getSchema()
.
בהתאם למקור הנתונים של המחבר ולתצורה שסופקה על ידי המשתמש, ייתכן שהסכימה תתוקן או שתצטרכו לספק זאת באופן דינמי בזמן הבקשה.
לדוגמה, אם מחבר מאחזר נתוני דוח על סמך מזהה דוח, הנתונים שמוחזרים עבור הדוח הזה עלולים שלא להיות ידועים מראש.
במקרה כזה, יכול להיות שתידרשו לאחזור נתונים ב-getSchema()
ויהיה צורך לחשב את הסכימה.
אחזור והחזרת נתונים באמצעות getData()
הפונקציה הזו נקראת כדי לקבל נתונים לגבי הבקשה הנתונה. כל הפרמטרים של הגדרה שהוגדרו על ידי הפונקציה getConfig()
יסופקו בארגומנט request
. פרטים נוספים זמינים בחומר עזר בנושא getData()
.
לפרמטרים הבאים מהאפליקציה getData()
נדרשת תשומת לב נוספת:
lastRefresh
lastRefresh
מייצג חותמת זמן שמציינת את המועד של הבקשה האחרונה לרענון נתונים. תוכלו לנתח את הערך באמצעותnew Date(timestampString)
. אם אתם משתמשים ב-Apps Script Cache או בכל שיטת שמירה אחרת במטמון, חותמת הזמן שלlastRefresh
יכולה לעזור לכם להחליט אם צריך לשלוח בקשת אחזור חדשה למקור הנתונים או להציג נתונים מהמטמון.dateRange
אםdateRangeRequired
מוגדרת לערךtrue
ב-getConfig()
, כל קריאה ל-getData()
תכיל את טווח התאריכים שנבחר בבקשה. מידע נוסף מופיע במאמר עבודה עם טווחי תאריכים.
בדוגמה הבאה מאחזרים נתונים על סמך הבקשה הנכנסת ומחזירים את הנתונים הסטטיסטיים של החבילה:
השלמת התהליך של המניפסט של הפרויקט
קובץ המניפסט מכיל מידע על מחבר הקהילה שלכם, שנדרש כדי לפרוס את המחבר שלכם ב-Looker Studio ולהשתמש בו.
כדי לערוך את קובץ המניפסט בסביבת הפיתוח של Apps Script, לוחצים על התפריט View ולוחצים על Show file file (הצגת קובץ המניפסט). ייווצר קובץ מניפסט חדש מסוג appsscript.json
.
צריך לעדכן את המניפסט כך שיכלול את הנתונים הבאים:
פרטים נוספים על המניפסט של Looker Studio זמינים בקובץ העזר למניפסט.
השלבים הבאים
בשלב הבא, פורסים את מחבר הקהילה.