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

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

הפעלת Drive API

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

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

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

  להפעלת ה-API

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

1. במסוף Google API, נכנסים לתפריט > ממשקי API ו- שירותים > ממשקי API מופעלים שירותים.

   מעבר לדף Enabled APIs & שירותים

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

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

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

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

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

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

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

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

11. כדי להשתמש באפשרות "חדש" בממשק המשתמש של Drive" לחצן ולבקש מהמשתמשים ליצור קובץ מסמנים את התיבה יצירת קבצים. כתובת URL חדשה ואופציונלי יופיעו השדות שם המסמך.

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

12. מזינים כתובת URL בשדה כתובת URL חדשה. כתובת האתר הזו נמצאת בשימוש בשדה New (חדש) לחצן כדי להפנות את המשתמשים לאפליקציה שלכם.

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

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

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

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

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

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

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

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

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

הפרמטר state

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

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

הפרמטר state מקודד בכתובת URL, ולכן האפליקציה חייבת לטפל בתו בריחה (escape) ולנתח אותו כקובץ 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"
}

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

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

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

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