יצירת תוספים ל-Google Workspace

רוצים ליצור תוסף חדש? Google Workspace

  1. מגדירים את הפרויקטים של התוסף ובוחרים בעלים ושותפי עריכה.
  2. מעצבים את המראה וההתנהגות של התוסף.
  3. הגדרת מניפסט הפרויקט או משאב הפריסה.
  4. צריך לכתוב קוד כדי להגדיר את המראה וההתנהגות של התוסף.
  5. אימות היקפי OAuth של התוסף.
  6. בדקו את התוסף הרלוונטי לאפליקציות המארחות.
  7. מפרסמים את התוסף.

מגדירים את הפרויקטים של התוסף ובוחרים בעלים ושותפי עריכה

אם אתם בונים את התוסף שלכם ב-Apps Script, אתם יוצרים פרויקט Apps Script וגם פרויקט של Google Cloud. אם אתם בונים את התוסף בשפה שאינה Apps Script, צריך ליצור רק פרויקט ב-Google Cloud.

לפני שמתחילים לפתח את התוסף, בוחרים חשבון משתמש אחד כדי להיות הבעלים של הפרויקטים ולהחליט אילו חשבונות אחרים הם שותפי עריכה. הבעלים של הפרויקטים יוצר ומנהלים את קובצי הפרויקט ואת ההגדרות המשויכות אליהם, ואילו שותפי העריכה יכולים לעזור בתכנות ובבדיקה.

פרויקטים של Apps Script

ניתן ליצור את קובצי הפרויקט של תוסף Apps ב-Drive שיתופי כך שלכל חשבון לא תהיה בעלות בלעדית. כשמוסיפים קובץ סקריפט של תוסף לאחסון שיתופי, אפשר להבטיח שלמספר שותפי עריכה תמיד תהיה גישה לפרויקט הסקריפט.

כשמפרסמים תוסף, חשבון משתמש יחיד פועל בתור בעל התוכן הדיגיטלי. לחשבון הפרסום צריכה להיות גישת עריכה לפרויקט הסקריפט, אבל הוא לא חייב להיות הבעלים.

פרויקטים ב-Google Cloud

אנחנו ממליצים להוסיף שותפי עריכה לפרויקט בענן של התוסף. כך אפשר להבטיח שלמישהו בצוות שלך תמיד תהיה גישה להגדרות בענן.

עיצוב והתנהגות התוספים

חשוב לבדוק איך אתם רוצים שהתוסף יוצג, ואיך הוא צריך לפעול לפני שמתחילים ליצור אותו. שימו לב לתרחישים לדוגמה שהתוסף צריך לנסות לספק עבורם. תוכלו להתחיל עם עיצוב פשוט כדי להתחיל לעבוד, ואז להוסיף עוד חידודים.

הנחיות ליצירת העיצוב של חוויית המשתמש בתוסף מפורטות בGoogle Workspace מדריך לסגנון התוסף.

הגדרה של מניפסט הפרויקט לתוסף

בפרויקטים של Apps Script, מניפסט הפרויקט הוא קובץ JSON מיוחד. הוא מציין מגוון פרטים על הפרויקט, למשל, יחסי תלות של ספרייה. עבור Google Workspace התוספים, המניפסט מספק גם את המידע הבסיסי שהאפליקציה המארחת צריכה כדי להציג את התוסף בצורה נכונה.

בקטע מניפסט מופיעים פרטים על הגדרת המניפסט של התוסף ל-Apps Script.

כשאתם מוסיפים קוד ותכונות לתוסף, תוכלו לערוך את המניפסט לפי הצורך כדי ליצור את המראה וההתנהגות הנדרשים של התוסף.

קוד התוסף

עליכם להטמיע ממשק מבוסס-כרטיסים עבור התוסף. השתמשו ב-Apps Script'sבשירות הכרטיס. לחלופין, אם אתם כותבים בשפת קוד אחרת, יש להחזיר את פורמט JSON בפורמט הנכון כדי שהממשק יוצג ככרטיסים.

יש ליישם גם פונקציות טריגר המפורטות במניפסט של התוסף. אם התוסף מתחבר לשירות של צד שלישי שהוא לא Google דרך OAuth, צריך גם להגדיר את ה-OAuth עבור השירות הזה.

בניית כרטיסים

אתם מגדירים ממשק משתמש של תוסף על ידי יצירה של Card אובייקטים ומילוי שלהם בווידג'טים. פונקציות טריגר שצוינו במניפסט צריכות להחזיר אובייקט Card אחד או מערך של אובייקטים מסוג Card שמייצגים ממשק #&99;#&39; התוסף יכול גם ליצור כרטיסים חדשים ולהציג אותם בתגובה לפעולות המשתמש.

בסקריפט של Apps, יצירת הכרטיסים מתבצעת באמצעות הכיתה CardBuilder. כל כרטיס מחייב CardHeader ואחד או יותר CardSections. צריך לאכלס כל קטע בכרטיס בווידג'טים השונים שמהם מורכב ממשק התוסף. ווידג'טים של אינטראקציות מקושרים בדרך כלל לפעולות כדי להגדיר את התנהגות האינטראקציה שלהם.

אחרי שמוסיפים את כל הקטעים והווידג'טים לכרטיס דרך ה-CardBuilder, צריך להתקשר אל CardBuilder.build() כדי ליצור את האובייקט התואם של Card.

תוכלו להשתמש בשירותי Apps Script מובנים אחרים, כמו CalendarApp, כדי לאחזר מידע שיוצג בכרטיסי התוספים שתיצרו. אתם יכולים להשתמש בנתונים שאוחזרו משירותים שאינם של Google.

אם לתוסף Google Workspace דרושה גישה לממשקי API שאינם של Google המחייבים אימות OAuth, עליך להגדיר את השירות ולהתחבר אליו. לפרטים נוספים, ניתן לעיין במדריך להתחברות לשירותים שאינם של Google.

צו בנייה

כש צריך ליצור כרטיס, יש לבנות אותו מלמעלה. כלומר, צריך להשתמש בהזמנת הבנייה הזו:

  1. ליצור את הווידג'ט.
  2. מוסיפים את הווידג'ט לקטע של הכרטיס.
  3. חוזרים על הפעולות עד שהקטע בכרטיס יכלול את כל הווידג'טים שלו.
  4. מוסיפים את קטע הכרטיס לכרטיס.

הפעולות האלה נדרשות כי כשמוסיפים ווידג'ט לקטע של כרטיס או כרטיס, למעשה מוסיפים עותק של הווידג'ט הזה. כל שינוי שתבצעו באובייקט הווידג'ט אחרי שהוספתם אותו לא יבוא לידי ביטוי בכרטיס הסופי.

פעולות אוניברסליות

תוכלו להשתמש בפעולות אוניברסליות כדי לספק פונקציונליות שלא תלויה בהקשר. פעולות אוניברסליות הן אפשרויות בתפריט הזמינות בממשק המשתמש של התוסף, ללא קשר לכרטיס שמוצג כרגע. כל הפעולות האוניברסליות שהוגדרו מופיעות תמיד בתפריט הכרטיסים של התוסף.

לפרטים נוספים, ראו פעולות אוניברסליות.

אימות היקפי OAuth של התוסף

היקפים מגדירים אילו פעולות התוסף יכול לבצע בשם משתמש. השיטה המומלצת לתוספים היא להגדיר רק היקפי פעולות לפעולות שחייבים להיות לה, ולא פעולות נוספות.

בפרויקטים של תוספים, יש להגדיר את ההיקפים של התוספים באופן מפורש כדי להבטיח שהתוסף יכלול את קבוצת ההיקפים הפחות מגבילה שאפשר. מגדירים את ההיקפים שבהם התוסף משתמש במניפסט.

לפרטים נוספים, אפשר לעיין בהיקפים.

בדיקת התוסף

תוכלו לבדוק תוספים שלא פורסמו על ידי התקנת התוסף שלא פורסם. לאחר ההתקנה וההרשאה, תוכלו להשתמש בתוסף בחשבון ולבדוק את המראה וההתנהגות של האפליקציות המארחות שהוא מרחיב. מומלץ לוודא שהתוסף פועל כצפוי בהקשרים ובפעולות של משתמשים.

לפרטים נוספים, ראו בדיקה Google Workspace תוספים.

פרסום התוסף

פרסום התוסף הופך אותו לזמין לאחרים, באופן ציבורי או רק למשתמשים בדומיין שלכם. לפני שמתחילים בתהליך הפרסום, חשוב לקרוא את הסקירה הכללית של אתר החדשות. יצירת אתר חדשות היא תהליך מורכב שנדרשת הכנה וזמן להשלמתה.

Google Workspace תוספים מתפרסמים ב-Google Workspace Marketplace. תוספים המתפרסמים באופן ציבורי חייבים להשלים את בדיקת האפליקציה לפני הפרסום.

מידע נוסף זמין בקטע פרסום Google Workspace תוסף.

Google Workspace דוגמה לתוסף

 l10n-placeholder41=

כדי לעזור לכם להבין Google Workspace איך תוספים תוכננו, ה-Google Workspace "Cats" התוסף למתחילים מדגים איך ליצור תוסף Google Workspace פשוט, כולל דפי בית, ניווט בכרטיסים וחיבורים לשירות של צד שלישי. לאחר השלמה של תהליך ההפעלה, תוכלו להתקין את התוסף ולהתנסות בקוד.