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

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

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

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

מקורות

'מקורות' היא רשימה של טיפוסים בני מנייה (enums) למקורות. אפשר לראות את רשימת המקורות הקיימת במאגר הנתונים במרשם הנתונים. אם המקור שאליו אתם מתחברים לא קיים במאגר, צריך לשלוח בקשת משיכה למאגר הנתונים במרשם הנתונים כדי להוסיף את המקור. שם המקור יכול להכיל רק תווים באותיות רישיות וקווים תחתונים (למשל, Google Analytics יהיה GOOGLE_ANALYTICS). במניפסט של מחבר הקהילה, יש להשתמש ב-value של נכס מזהה מקור הנתונים, למשל GOOGLE_ANALYTICS.

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

זוהי דוגמה למניפסט שהושלם:

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