פיתוח ממשקים ב-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"
          },
          ...
        ]
      },
      ...
    }