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

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

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

שם המאפיין	סוג	תיאור
חובה (במאפיין `dataStudio`)
`name`	`string`	השם של המחבר. Limited to 28 characters
`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`	המשמעות היא שהמשתמש יצטרך לשלם כדי להשתמש בכלי לחיבור.

מקורות

‫Sources היא רשימה של ערכי 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/"]
}