הגדרת שילוב של ממשק המשתמש ב-Drive

כדי שהאפליקציה שלכם תוצג ב-Google Drive כשמשתמש יוצר או פותח קובץ, אתם צריכים קודם להגדיר שילוב של ממשק משתמש (UI) ב-Drive. צריך להגדיר את האפליקציה גם כדי להציג אותה ב-Google Workspace Marketplace.

הפעלת Drive API

לפני שאתם משתמשים בממשקי Google API, אתם צריכים להפעיל אותם בפרויקט ב-Google Cloud. בכל פרויקט אפשר להפעיל ממשק API אחד או יותר.

כדי להתחיל לשלב את ממשק המשתמש של Google Drive, צריך להפעיל את Drive API. כך תקבלו גישה ל-API ולתכונות של שילוב ממשק המשתמש.

• במסוף Google Cloud, מפעילים את Google Drive API.

  להפעלת ה-API

הגדרת השילוב של ממשק המשתמש ב-Drive

1. ב-Google API Console, נכנסים לתפריט > APIs & Services > Enabled APIs & services.

   כניסה אל Enabled APIs & services

2. בחלק התחתון של מרכז הבקרה של ממשקי ה-API והשירותים, לוחצים על Google Drive API. יופיע דף ההגדרות של Google Drive API.
3. לוחצים על הכרטיסייה Drive UI integration.
4. (אופציונלי) מזינים שם בשדה Application name. שם האפליקציה מוצג למשתמשים בכרטיסייה "ניהול אפליקציות" בהגדרות של Drive.
5. (אופציונלי) בשדה Short description, מזינים תיאור קצר בשורה אחת. התיאור הקצר מוצג למשתמשים בכרטיסייה "ניהול אפליקציות" בהגדרות של Drive.
6. (אופציונלי) מזינים תיאור מלא בשדה תיאור ארוך.

7. מעלים סמל אפליקציה אחד או יותר שיוצג ברשימת האפליקציות המקושרות ל-Drive של המשתמש ובתפריט ההקשר "פתיחה באמצעות". הסמלים צריכים להיות בפורמט PNG עם רקע שקוף. יכול להיות שיעברו עד 24 שעות עד שהסמלים יופיעו ב-Drive.

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

8. כדי להשתמש בפריט בתפריט "פתיחה באמצעות" בממשק המשתמש של Drive, מזינים את כתובת ה-URL של האפליקציה בשדה פתיחת כתובת URL. כתובת ה-URL הזו משמשת את תפריט ההקשר "פתיחה באמצעות".

   • כתובת ה-URL הזו חייבת להכיל שם דומיין שמוגדר במלואו. localhost לא עובד.
   • כתובת ה-URL הזו צריכה להיות נגישה למשתמשים המיועדים של האפליקציה. אם יש לכם כמה גרסאות של האפליקציה, למשל גרסה אחת לפרסום ציבורי וגרסה אחת לפרסום מוגבל למשתמשים נבחרים, לכל גרסה צריכה להיות כתובת URL ייחודית. אחר כך אפשר ליצור הגדרות שונות לאפליקציה לכל גרסה.
   • כדי לפרסם את האפליקציה ב-Google Workspace Marketplace, צריך לאמת את הבעלות על כתובת ה-URL הזו.
   • כברירת מחדל, פרמטר השאילתה state מצורף לכתובת ה-URL הזו כדי להעביר נתונים מממשק המשתמש של Drive לאפליקציה. למידע על התוכן של הפרמטר state, קראו את המאמר הפרמטר state.
   אזהרה: האפשרות להציג באופן אוטומטי את מסך ההסכמה של OAuth 2.0 הוצאה משימוש. אל תסמנו את התיבה הזו. האפליקציה חייבת להתחיל את כל בקשות ההרשאה.

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

10. (אופציונלי) מזינים סוגי MIME וסיומות קבצים משניים בשדות סוגי MIME משניים וסיומות קבצים משניות. סוגי MIME וסיומות קבצים משניים מייצגים קבצים שהאפליקציה יכולה לפתוח, אבל הם לא ספציפיים לאפליקציה. לדוגמה, יכול להיות שהאפליקציה היא אפליקציה לעריכת תמונות שפותחת תמונות PNG ו-JPG. צריך לכלול רק סוגי מדיה סטנדרטיים ולוודא שאין בהם שגיאות הקלדה או שגיאות כתיב. אם האפליקציה פותחת רק קובצי קיצורי דרך או קובצי קיצורי דרך של צד שלישי, אפשר להשאיר את סוג ה-MIME ריק.

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

11. כדי להשתמש בלחצן "חדש" בממשק המשתמש של Drive ולאפשר למשתמשים ליצור קובץ באמצעות האפליקציה, מסמנים את התיבה יצירת קבצים. השדות New URL ו-Document name (אופציונלי) מופיעים.

    • כתובת ה-URL הזו חייבת להכיל שם דומיין שמוגדר במלואו. localhost לא עובד.
    • כדי לפרסם את האפליקציה ב-Google Workspace Marketplace, צריך לאמת את הבעלות על כתובת ה-URL הזו.
    • כברירת מחדל, פרמטר השאילתה state מצורף לכתובת ה-URL הזו כדי להעביר נתונים מממשק המשתמש של Drive לאפליקציה. למידע על התוכן של הפרמטר state, קראו את המאמר הפרמטר state.

12. מזינים כתובת URL בשדה כתובת URL חדשה. כתובת ה-URL הזו משמשת את הלחצן "חדש" כדי להפנות את המשתמש לאפליקציה שלך.

    הערה: משאירים את השדה Document name (שם המסמך) ריק. השדה הזה כבר לא בשימוש.

13. (אופציונלי) אם רוצים שהאפליקציה תפתח קבצים שנתמכים ב-Google Workspace, מסמנים את התיבה ייבוא.

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

15. לוחצים על שליחה.

בקשת היקף ההרשאות drive.install

כדי לאפשר לאפליקציות להופיע כאפשרות בתפריט "פתיחה באמצעות" או בתפריט "חדש", צריך לבקש את ההיקף https://www.googleapis.com/auth/drive.install כדי לשלב עם ממשק המשתמש של Drive. כשמבקשים את ההיקף הזה, המשתמשים מקבלים תיבת דו-שיח דומה לזו:

תרשים 1. תיבת הדו-שיח של ההתקנה כשמשתמשים בהיקפי הרשאות לממשק המשתמש של Drive.

במאמר מידע על הרשאה ואימות ספציפיים ל-API מוסבר אילו היקפי הרשאות אפשר לבקש לאפליקציות Drive ואיך לבקש אותם.

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

הפרמטר state

כברירת מחדל, הפרמטר state מצורף גם לכתובת ה-URL לפתיחה וגם לכתובת ה-URL החדשה כדי להעביר נתונים מממשק המשתמש של Drive לאפליקציה. הפרמטר הזה מכיל מחרוזת בקידוד JSON עם משתני תבנית ונתונים לגבי הבקשה לאפליקציה. המשתנים שנכללים תלויים בסוג כתובת ה-URL שבה משתמשים (כתובת URL לפתיחה או כתובת URL חדשה):

משתנה של תבנית	תיאור	אפליקציית URL
{ids}	רשימה מופרדת בפסיקים של מזהי קבצים שנפתחים.	פתיחת כתובת URL
{exportIds}	רשימה מופרדת בפסיקים של מזהי קבצים שמיוצאים. משמש רק לפתיחת קבצים ב-Google Workspace.	פתיחת כתובת URL
{resourceKeys}	מילון JSON של מזהי קבצים שממופים למפתחות המשאבים שלהם.	פתיחת כתובת URL
{folderId}	המזהה של תיקיית ההורה.	כתובת URL חדשה
{folderResourceKey}	מפתח המשאב של תיקיית ההורה.	כתובת URL חדשה
{userId}	מזהה הפרופיל שמזהה את המשתמש.	פתיחת כתובת URL וכתובת URL חדשה
{action}	הפעולה שמתבצעת. הערך הוא open כשמשתמשים בכתובת URL פתוחה, או create כשמשתמשים בכתובת URL חדשה.	פתיחת כתובת URL וכתובת URL חדשה

הפרמטר state מקודד בכתובת URL, כך שהאפליקציה צריכה לטפל בתווי המילוט ולנתח אותו כ-JSON. אפליקציות יכולות לזהות את הערך create בפרמטר state כדי לאמת בקשה ליצירת קובץ.

דוגמה למידע על מצב ב-JSON לכתובת URL חדשה

המידע על state בכתובת URL חדשה הוא:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

דוגמה למידע על מצב ב-JSON לפתיחת כתובת URL

המידע של state לגבי כתובת URL פתוחה הוא:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

המזהים ומפתחות המשאבים משמשים לאחזור מטא-נתונים של קבצים ולהורדת תוכן של קבצים. אחרי שהאפליקציה מקבלת את מזהה הקובץ ואת טוקן הגישה, היא יכולה לבדוק את ההרשאות, לאחזר את המטא-נתונים של הקובץ ולהוריד את התוכן שלו, כמו שמתואר ב-method‏ files.get.

הערה: כל האפליקציות, כולל אפליקציות שפותחות קבצים מקיצורי דרך ומקיצורי דרך של צד שלישי, צריכות להפעיל את השיטה files.get כדי לבדוק את הרשאות המשתמש למסמך. האפליקציות צריכות להזהיר משתמשים עם הרשאת קריאה בלבד כשהם פותחים קובץ שהם לא יכולים לערוך או לשמור (במקום לאפשר להם להשקיע זמן בעריכה, ואז להציג שגיאה בשמירה).

נושאים קשורים

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