פיתוח ממשקים ב-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 השדה הזה. הפונקציה הזו מקבלת אובייקט event כארגומנט והם חייבים להחזיר אחד אובייקט Card או מערך של Card אובייקטים.

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

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

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

המבנה המלא של אובייקטי אירועים מתואר אובייקטים של אירועים. כש-Drive היא האפליקציה המארחת הפעיל של התוסף, אובייקטים של אירועים לפי הקשר כוללים את אובייקט של אירוע ב-Drive שכולל את פרטי הלקוח הספציפיים ל-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"
          },
          ...
        ]
      },
      ...
    }