פיתוח ממשקים ב-Google Drive

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

גישה לממשק המשתמש של התוסף

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

• אם משתמש לוחץ על סמל התוסף ב-Google Drive, התוסף מפעיל את הפונקציה התואמת drive.homepageTrigger (אם היא קיימת). הפונקציה הזו יוצרת כרטיס לדף הבית ומחזירה אותו ל-Google Drive לתצוגה. אם לא מוגדרת פונקציה של drive.homepageTrigger, מוצג במקומה כרטיס גנרי של דף הבית.
• אם המשתמש בוחר פריט אחד או יותר ב-Google Drive ואז לוחץ על סמל התוסף, או בוחר פריטים כשהתוסף פתוח, התוסף מפעיל את הפונקציה ההקשרית המתאימה drive.onItemsSelectedTrigger (אם היא קיימת). הפונקציה הזו יוצרת את ממשק 'הפריטים שנבחרו' ההקשרי של Google Drive לתוסף ומחזירה אותו ל-Google Drive להצגה.

פיתוח הממשק של התוסף ל-Drive

כדי ליצור ממשקים שמרחיבים את Google Drive, צריך לבצע את השלבים הכלליים הבאים:

1. מחליטים אם רוצים שלתוסף יהיה דף בית ספציפי ל-Drive. כדאי גם להחליט אם רוצים לספק ממשק לפי הקשר כשמשתמש בוחר פריטים ב-Drive.
2. מוסיפים את השדות המתאימים addOns.common ו-addOns.drive לקובץ המניפסט של פרויקט הסקריפט של התוסף, כולל היקפי הגישה ל-Drive שנדרשים.
3. אם אתם מספקים דף בית ספציפי ל-Drive, צריך להטמיע את הפונקציה drive.homepageTrigger כדי ליצור את הממשק הזה. אפשר גם להשתמש בממשק common.homepageTrigger למספר מארחים של Google Workspace.
4. אם אתם מספקים ממשק לבחירת פריטים בהקשר של Drive, אתם צריכים להטמיע פונקציית טריגר הקשרית drive.onItemsSelectedTrigger כדי ליצור את הממשק הזה. פרטים נוספים מופיעים במאמר בנושא ממשק תלוי-הקשר של Drive לפריטים שנבחרו.
5. מטמיעים את פונקציות הקריאה החוזרת שנדרשות כדי להגיב לאינטראקציות של המשתמש עם ממשק המשתמש, כמו לחיצות על כפתורים.

דפי הבית של Drive

‫Google Drive תומך בהצגה של דפי הבית של תוספים ל-Google Workspace. כדי להציג את דף הבית המשותף של התוסף ב-Google Drive, צריך לוודא שיש שדה addOns.drive במניפסט של התוסף.

אפשר גם להוסיף את התג drive.homepageTrigger למניפסט של התוסף כדי לספק דף בית ספציפי ל-Drive.

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

ממשק הקשרי ב-Drive לפריטים שנבחרו

‫Google Drive מסתמך על טריגר הקשרי כדי לקבוע איזה ממשק (אם בכלל) יוצג כשהמשתמש בוחר פריט אחד או יותר ב-Google Drive. כשהטריגר מופעל, הוא מריץ את פונקציית הטריגר ההקשרית שצוינה בשדה drive.onItemsSelectedTrigger.runFunction במניפסט של התוסף.

כדי ליצור ממשק לבחירת פריטים בהקשר מסוים ב-Drive, צריך לבצע את הפעולות הבאות:

1. מוודאים שקובץ המניפסט של התוסף כולל את https://www.googleapis.com/auth/drive.addons.metadata.readonly ההיקף

2. מוודאים שהמניפסט כולל את הקטע drive.onItemsSelectedTrigger.

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

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

אובייקטים של אירועים

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

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

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

בדוגמה הבאה מוצג אובייקט של אירוע ב-Drive שמועבר לפונקציה drive.onItemsSelectedTrigger:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }