הפניה למניפסט

המניפסט (appsscript.json) הוא קובץ JSON במחבר Apps Script שלך פרויקט. התווית מכילה מידע מסוים על מחבר הקהילה שלך שנדרש לפרוס את המחבר ולהשתמש בו ב-Looker Studio. עוד פרטים על מניפסטים ב-Apps Script.

אזהרה: יש להביא בחשבון כל מידע שמזינים בקובץ המניפסט ציבורי.

המניפסט צריך לכלול את הפרטים הבאים:

שם הנכס	סוג	תיאור
חובה (מתחת לנכס dataStudio)
name	string	שם המחבר. מוגבל ל-28 תווים
company	string	שם הארגון או המפתח.
companyUrl	string (link)	קישור לאתר של הארגון או של המפתח.
logoUrl	string (image link)	כתובת ה-URL של סמל עבור המחבר שלך. המימדים הנדרשים הם 40px על 40px.
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)	רשימה של קידומות של כתובות URL מסוג HTTPS שהמחבר משתמש בהן. כל נקודת קצה בכתובת 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). במניפסט של מחבר הקהילה, יש להשתמש בערך של מזהה מקור הנתונים נכס, למשל GOOGLE_ANALYTICS

מניפסט לדוגמה של מחבר קהילה

דוגמה למניפסט מלא:

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