דפי בית

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

דפי בית מאפשרים להציג תוכן שאינו לפי הקשר, בדיוק כמו האפליקציות של Google חלונית צדדית לגישה מהירה (Keep, יומן Google ו-Tasks). דפי הבית יכולים גם לספק יתרון התחלתי מקום שבו המשתמש פותח לראשונה את התוסף, והם שימושיים להוראה למשתמשים חדשים כיצד לקיים אינטראקציה עם התוסף שלכם.

אפשר להגדיר דף בית לתוסף על ידי ציון הדף בפרויקט מניפסט והטמעה של פונקציית homepageTrigger אחת או יותר (ראו הגדרת דף הבית).

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

דף הבית של התוסף מוצג אם אחד מהתנאים הבאים מתקיים:

  • פתיחה ראשונה של התוסף אצל המארח (אחרי קבלת ההרשאה).
  • כשהמשתמש עובר מהקשר הקשרי להקשר שאינו לפי הקשר. בזמן שהתוסף פתוח. לדוגמה, מעריכת אירוע ביומן ביומן הראשי.
  • כשהמשתמש לוחץ על לחצן 'הקודם' מספיק פעמים כדי מסירים כל כרטיס מהערימות הפנימיות.
  • כשאינטראקציה בממשק המשתמש בכרטיס שאינו לפי הקשר מובילה Navigation.popToRoot() שיחה.

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

הגדרת דף הבית

תוספים ל-Google Workspace משתמשים addOns.common.homepageTrigger כדי להגדיר את תוכן ברירת המחדל של התוסף לדף הבית (לא לפי הקשר) עבור את כל האפליקציות המארחות בתוסף מניפסט:

    {
      // ...
      "addOns": {
        // ...
        "common": {
          // ...
          "homepageTrigger": {
            "runFunction": "myFunction",
            "enabled": true
          }
        }
      }
    }

  • runFunction: השם של פונקציית Apps Script ש ה-framework של התוספים ל-Google Workspace מפעיל את כרטיסי התוספים בדף הבית כדי לעבד אותם. הפונקציה הזו היא פונקציית הטריגר של דף הבית. הפונקציה הזו צריכה ליצור ומחזירה מערך של Card האובייקטים שמרכיבים את ממשק המשתמש של דף הבית. אם מוחזר יותר מכרטיס אחד, האפליקציה המארחת מציגה את כותרות הכרטיסים ברשימה שהמשתמש יכול לבחור בה החל מ- (ראו החזרה של מספר כרטיסים).

  • enabled: האם להפעיל את כרטיסי דף הבית בהיקף הזה. הזה הוא אופציונלי וברירת המחדל שלו היא true. אם מגדירים את הערך הזה כ-false, כדי להשבית את הכרטיסים בדף הבית של כל המארחים (אלא אם הם יבוטלו host; מידע נוסף מופיע בהמשך).

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

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

שימו לב שזה מקביל לקטע המניפסט הבא:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

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

זרימת דף הבית

אובייקטים של אירוע בדף הבית

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

האובייקטים של האירוע בדף הבית לא כוללים ווידג'ט או מידע הקשרי ה המידע שמועבר מוגבל לפרטים הבאים אובייקט אירוע נפוץ שדות:

פרטים נוספים מופיעים בקטע אובייקט אירוע.

כרטיסים אחרים ללא הקשר

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

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