סקירה כללית של אפליקציות למחשב

הערה: זו גרסת בטא של Google Picker API לאפליקציות למחשב.

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

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

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

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

דרישות מוקדמות

אפליקציות שמשתמשות ב-Google Picker חייבות לפעול בהתאם לכל התנאים וההגבלות הקיימים. הכי חשוב, עליכם לזהות את עצמכם בצורה נכונה בבקשות.

צריך גם פרויקט ב-Google Cloud.

הגדרת הסביבה

כדי להתחיל להשתמש ב-Google Picker API, צריך להגדיר את הסביבה.

הפעלת ה-API

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

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

  להפעלת ה-API

יצירה של מפתח API

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

כך יוצרים מפתח API:

1. במסוף Google Cloud, לוחצים על סמל התפריט > APIs & Services > Credentials.

   כניסה לדף Credentials

2. לוחצים על Create credentials > API key.
3. מפתח ה-API החדש מוצג.
   • לוחצים על סמל ההעתקה כדי להעתיק את מפתח ה-API לשימוש בקוד של האפליקציה. מפתח ה-API מופיע גם בקטע API Keys (מפתחות API) בפרטי הכניסה של הפרויקט.
   • כדי למנוע שימוש לא מורשה, מומלץ להגביל את המקומות שבהם אפשר להשתמש במפתח ה-API ואת ממשקי ה-API שאפשר להשתמש בו עבורם. פרטים נוספים זמינים במאמר בנושא הוספת הגבלות על ממשקי API.

אישור פרטי הכניסה של אפליקציה למחשב

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

1. במסוף Google Cloud, עוברים אל תפריט > Google Auth platform > Clients.

   כניסה לדף Clients

2. לוחצים על Create Client.
3. לוחצים על Application type‏ > Desktop app.
4. בשדה Name, מקלידים שם לפרטי הכניסה. השם הזה מוצג רק במסוף Google Cloud.
5. לוחצים על Create.

   פרטי הכניסה החדשים שנוצרו מופיעים בקטע OAuth 2.0 Client IDs.

כדי שאפליקציות יקבלו הרשאה לגשת לקבצים שההרשאה אליהם ניתנה להן בעבר, צריך לבצע את השלבים הבאים:

1. צריך לקבל אסימון OAuth 2.0 עם היקף ההרשאות drive.file, drive או drive.readonly באמצעות ההוראות האלה: שימוש ב-OAuth 2.0 כדי לגשת אל Google APIs. מידע נוסף על היקפי הרשאות זמין במאמר בחירת היקפי הרשאות של Google Drive API.

2. מעבירים את אסימון OAuth 2.0 אל Drive API כדי לקרוא ולשנות קבצים שהמשתמש העניק גישה אליהם בעבר.

הצגת הכלי לבחירת קבצים של Google

ה-API של כלי הבחירה של Google לאפליקציות למחשב מפנה לכלי הבחירה של Google בכרטיסייה חדשה בדפדפן ברירת המחדל של המשתמש. אחרי שהמשתמש מעניק גישה ובוחר את הקבצים הרלוונטיים, הכלי לבחירת קבצים של Google חוזר לאפליקציה שקוראת לו דרך כתובת ה-URL של הקריאה החוזרת. כדי ש-Google Picker API ייפתח בדף לקוח, צריך להשתמש ב-Google Picker API לאפליקציות אינטרנט. מידע נוסף זמין במאמר סקירה כללית של אפליקציות אינטרנט.

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

1. כדי לבקש גישה להיקף ההרשאות drive.file ולפתוח את דף הגישה של OAuth 2.0 בכרטיסייה חדשה בדפדפן, צריך לפעול לפי ההוראות במאמר שימוש ב-OAuth 2.0 כדי לגשת ל-Google APIs. מידע נוסף על היקפי הרשאות זמין במאמר בחירת היקפי הרשאות של Google Drive API.

   שימו לב שמותר להשתמש בהיקף drive.file בלבד באפליקציות למחשב, ואי אפשר לשלב אותו עם היקפים אחרים.

2. כתובת ה-URL של כרטיסיית הדפדפן החדשה מקבלת את כל הפרמטרים הרגילים של מחרוזת השאילתה של OAuth.

   צריך לצרף את פרמטרים של כתובת ה-URL prompt ו-trigger_onepick לבקשת כתובת ה-URL של הרשאת OAuth 2.0. אפשר גם להתאים אישית את כלי הבחירה של Google באמצעות כמה פרמטרים אופציונליים:

   פרמטר	תיאור	סטטוס
   prompt=consent	הצגת בקשה לגישה לקובץ.	חובה
   trigger_onepick=true	מפעילים את כלי הבחירה של Google.	חובה
   allow_multiple=true	אם הערך הוא True, המשתמש יכול לבחור כמה קבצים.	אופציונלי
   mimetypes=MIMETYPES	רשימה של סוגי MIME שמופרדים בפסיקים, לסינון תוצאות החיפוש. אם לא מגדירים את ההגדרה הזו, הקבצים מכל סוגי ה-MIME מוצגים בתצוגה.	אופציונלי
   file_ids=FILE_IDS	רשימה של מזהי קבצים שמופרדים בפסיקים, לסינון תוצאות החיפוש. אם לא מגדירים את ההגדרה הזו, כל הקבצים מוצגים בתצוגה.	אופציונלי

   בדוגמה הבאה מוצגת בקשה לכתובת URL להרשאה ב-OAuth 2.0:

   https://accounts.google.com/o/oauth2/v2/auth? \
   client_id=CLIENT_ID \
   &scope=https://www.googleapis.com/auth/drive.file \
   &redirect_uri=REDIRECT_URI \
   &response_type=code \
   &access_type=offline \
   &prompt=consent \
   &trigger_onepick=true
   

   מחליפים את מה שכתוב בשדות הבאים:

   • ‫CLIENT_ID: מזהה הלקוח של אפליקציית שולחן העבודה.

   • ‫REDIRECT_URI: כתובת ה-URL שאליה מועבר הדפדפן של המשתמש אחרי אימות מוצלח של שרת ההרשאות. לדוגמה, https://www.cymbalgroup.com/oauth2callback.

     כתובת ה-URL שצוינה redirect_uri חייבת להיות כתובת URL ציבורית מסוג HTTPS. אם רוצים להשתמש בפרוטוקול מותאם אישית או בכתובת URL של localhost בשביל redirect_uri, צריך להשתמש בכתובת URL ציבורית מסוג HTTPS שמפנה אל הפרוטוקול המותאם אישית או אל כתובת ה-URL של localhost.

3. אחרי שהמשתמש מעניק גישה ובוחר את הקבצים הרלוונטיים, מתבצעת הפניה אוטומטית של OAuth אל redirect_uri שצוין בבקשה, עם הפרמטרים הבאים של כתובת ה-URL שנוספו:

   • ‫picked_file_ids: אם המשתמש העניק גישה ובחר קבצים, רשימה מופרדת בפסיקים של מזהי הקבצים שנבחרו.

   • ‫code: אסימון הגישה או קוד הגישה על סמך הפרמטר response_type שהוגדר בבקשה. הפרמטר הזה כולל קוד הרשאה חדש.

   • ‫scope: ההיקפים שנכללים בבקשה.

   • ‫error: אם המשתמש ביטל את הבקשה בתהליך קבלת ההסכמה, תוצג שגיאה.

   בדוגמה הבאה מוצגת תגובה של כתובת URL להרשאה של OAuth 2.0:

   https://REDIRECT_URI?picked_file_ids=PICKED_FILE_IDS&code=CODE&scope=SCOPES
   

4. האפליקציות צריכות להחליף את קוד ההרשאה משלב 3 באסימון חדש מסוג OAuth 2.0. מידע נוסף זמין במאמר בנושא החלפת קוד הרשאה באסימוני רענון וגישה.

5. לאחר מכן, האפליקציות יכולות להשתמש במזהי הקבצים מפרמטר כתובת ה-URL בשלב 3 ובאסימון OAuth 2.0 שהתקבל בשלב 4 כדי לקרוא ל-Drive API. מידע נוסף זמין בסקירה הכללית על Google Drive API.