Dropbox
מחבר Dropbox מאפשר לכם להתחבר למופע של Dropbox ולבצע את הפעולות הנתמכות.
לפני שמתחילים
לפני שמשתמשים במחבר Dropbox, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-Google Cloud:
- מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM roles/connectors.admin.
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. המחבר וחשבון השירות צריכים להיות שייכים לאותו פרויקט. מידע נוסף זמין במאמר בנושא יצירת חשבון שירות.
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
הגדרת המחבר
החיבור הוא ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- מחבר: בוחרים באפשרות Dropbox מהרשימה הנפתחת של המחברים הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- אופציונלי: מזינים תיאור למופע החיבור.
- חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- אופציונלי: מגדירים את ההגדרות של צומת החיבור:
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר עסקאות לחיבור נדרשים יותר צמתים, ולהפך: כדי לעבד פחות עסקאות נדרשים פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- מזהה משתמש להתחזות:אפשרות לציין את מזהה המשתמש להתחזות.
- מצב התחברות זמנית כמשתמש אחר:אפשר לציין את סוג ההתחברות הזמנית כמשתמש אחר. הוא צריך להיות מצב משתמש או מצב אדמין.
- כולל תיקיות משנה:אופציונלי. אם רוצים לכלול תיקיות משנה כשמציגים רשימה של קבצים ותיקיות.
- כולל משאבים של הצוות:אם רוצים לכלול קבצים ותיקיות של הצוות.
- אופציונלי: לוחצים על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
חיבור Dropbox תומך בסוגי האימות הבאים:
- הרשאת קוד אימות OAuth 2.0
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- בדיקה: בודקים את פרטי החיבור והאימות.
- לוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
-
הרשאת קוד אימות OAuth 2.0
- Client ID: מזהה הלקוח שמשמש לבקשת אסימוני גישה.
- Scopes: רשימה מופרדת בפסיקים של ההיקפים הרצויים מפורטל ההרשאות של Dropbox.
- סוד לקוח: סוד הלקוח שמשמש לבקשת טוקנים של גישה.
ישויות, פעולות ופעולות
כל Integration Connectors מספקים שכבת הפשטה לאובייקטים של האפליקציה המחוברת. אפשר לגשת לאובייקטים של אפליקציה רק דרך ההפשטה הזו. ההפשטה מוצגת לכם כישויות, פעולות ופעולות.
- ישות: ישות היא אובייקט או אוסף של מאפיינים באפליקציה או בשירות המקושרים. ההגדרה של ישות משתנה ממחבר למחבר. לדוגמה, במחבר של מסד נתונים, הטבלאות הן הישויות, במחבר של שרת קבצים, התיקיות הן הישויות, ובמחבר של מערכת הודעות, התורים הם הישויות.
עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה
Entitiesתהיה ריקה. - פעולה: פעולה היא הפעילות שאפשר לבצע בישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:
בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה
Operations. - פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה
Actionsתהיה ריקה.
מגבלות המערכת
מחבר Dropbox יכול לעבד 18 עסקאות בשנייה, לכל צומת, ומגביל את כל העסקאות מעבר למגבלה הזו. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.
מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.
פעולות
בקטע הזה מפורטות הפעולות שהמחבר תומך בהן. כדי להבין איך להגדיר את הפעולות, אפשר לעיין בדוגמאות לפעולות.
פעולת CopyResource
הפעולה הזו מאפשרת להעתיק קובץ או תיקייה למיקום אחר ב-Dropbox של המשתמש.
פרמטרים של קלט לפעולה CopyResource
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| From_Path | String | כן | הנתיב ב-Dropbox של המשתמש שרוצים להעתיק או להעביר. |
| To_Path | String | כן | נתיב היעד ב-Dropbox של המשתמש למקור המידע שהועתק. |
| שינוי שם אוטומטי | String | לא | אם יש התנגשות, השרת של Dropbox ינסה לשנות את שם הקובץ באופן אוטומטי כדי למנוע את ההתנגשות. ברירת המחדל של השדה הזה היא False. |
| Allow_Ownership_Transfer | String | לא | לאפשר לבעלים להעביר תוכן גם אם ההעברה תגרום להעברת בעלות על התוכן. הכלל הזה לא חל על עותקים. ברירת המחדל של השדה הזה היא False. |
| ObjectPathsAggregate | String | לא | מצטבר שמייצג את נתיב האובייקט. יכול להיות גם השם של טבלת #TEMP. |
דוגמאות להגדרת הפעולה CopyResource מופיעות במאמר דוגמאות לפעולות.
פעולה CreateFolder
הפעולה הזו מאפשרת ליצור תיקייה בנתיב נתון.
פרמטרים של קלט לפעולה CreateFolder
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| נתיב | String | כן | הנתיב ב-Dropbox של המשתמש שרוצים ליצור. |
| AutoRename | בוליאני | לא | אם יש סתירה, שרת Dropbox ינסה לשנות את שם התיקייה באופן אוטומטי כדי למנוע את הסתירה. ערך ברירת המחדל הוא False. |
| ForceAsync | בוליאני | לא | האם ליצור את הפעולה באופן אסינכרוני. המאפיין הזה זמין רק כשמשתמשים ב-ObjectPathsAggregate. ערך ברירת המחדל הוא False. |
| ObjectPathsAggregate | String | לא | אובייקט JSON שמייצג את הנתיבים. יכול להיות גם השם של טבלת #TEMP. |
דוגמה להגדרת הפעולה CreateFolder מופיעה במאמר דוגמאות לפעולות.
הפעולה DeleteResource
הפעולה הזו מאפשרת למחוק קובץ או תיקייה בנתיב נתון. אם הנתיב הוא תיקייה, כל התוכן שלה יימחק גם כן.
פרמטרים של קלט לפעולה DeleteResource
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| נתיב | String | כן | מזהה ייחודי של הקובץ או התיקייה. |
| ObjectPathsAggregate | String | לא | מצטבר שמייצג את נתיב האובייקט. יכול להיות גם השם של טבלת #TEMP. |
דוגמאות להגדרת הפעולה DeleteResource מופיעות במאמר דוגמאות לפעולות.
פעולת MoveResource
העברת קובץ או תיקייה למיקום אחר ב-Dropbox של המשתמש. אם נתיב המקור הוא תיקייה, כל התוכן שלה יועבר. הערה: בשלב הזה אנחנו לא תומכים בשינוי שם שכולל רק שינוי של האותיות (לדוגמה, מ-a ל-A).
פרמטרים של קלט לפעולה MoveResource
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| From_Path | String | כן | הנתיב ב-Dropbox של המשתמש שרוצים להעתיק או להעביר. |
| To_Path | String | כן | הנתיב ב-Dropbox של המשתמש שהוא היעד. |
| שינוי שם אוטומטי | String | לא | אם יש התנגשות, השרת של Dropbox ינסה לשנות את שם הקובץ באופן אוטומטי כדי למנוע את ההתנגשות. ברירת המחדל של השדה הזה היא False. |
| Allow_Ownership_Transfer | String | לא | לאפשר לבעלים להעביר תוכן גם אם ההעברה תגרום להעברת בעלות על התוכן. הכלל הזה לא חל על עותקים. ברירת המחדל של השדה הזה היא False. |
| ObjectPathsAggregate | String | לא | מצטבר שמייצג את נתיב האובייקט. יכול להיות גם השם של טבלת #TEMP. |
דוגמאות להגדרת הפעולה MoveResource מופיעות במאמר דוגמאות לפעולות.
פעולת RenameResource
הפעולה הזו מאפשרת לשנות את השם של משאב על ידי ציון נתיב ושם חדש.
פרמטרים של קלט לפעולה RenameResource
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| נתיב | String | כן | הנתיב למשאב שרוצים לשנות את השם שלו. דוגמה: /myFolder/sample.txt |
| NewName | String | כן | השם החדש של המשאב. לדוגמה: sampleDocument.txt |
דוגמאות להגדרת הפעולה RenameResource מופיעות במאמר דוגמאות לפעולות.
פעולת ביטול שיתוף התיקייה
הפעולה הזו מאפשרת לבטל את השיתוף של תיקייה. נדרשת ההרשאה sharing.write.
פרמטרים של קלט לפעולה UnshareFolder
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| FolderId | String | כן | המזהה של התיקייה המשותפת שרוצים לבטל את השיתוף שלה. |
| LeaveCopy | String | לא | אם הערך הוא true, חברים בתיקייה המשותפת הזו יקבלו עותק של התיקייה אחרי שהשיתוף שלה יבוטל. ערך ברירת המחדל הוא False. |
דוגמאות להגדרת הפעולה UnshareFolder מופיעות במאמר דוגמאות לפעולות.
הפעולה DownloadFile
הפעולה הזו מאפשרת להוריד קובץ. נדרשת ההרשאה files.content.read.
פרמטרים של קלט לפעולה DownloadFile
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| מזהה | String | כן | המזהה של המסמך להורדה. |
| גרסה קודמת | String | לא | הגרסה של המסמך להורדה, לדוגמה rev:a1c10ce0dd78. |
| נתיב | String | לא | הנתיב של הקובץ או התיקייה להורדה. |
| AsZip | בוליאני | לא | להוריד תיקייה בפורמט ZIP. כדי להוריד תיקייה, צריך להגדיר את הערך true. |
| FileStream | String | לא | מופע של זרם פלט שבו נכתבים נתונים של קובץ. בשימוש רק אם לא מוגדר DownloadTo. |
| DownloadTo | String | לא | נתיב התיקייה שאליה יורד הקובץ. |
| FileType | String | כן | סוג הקובץ(קובץ או נייר) |
דוגמה להגדרת הפעולה DownloadFile מופיעה במאמר דוגמאות לפעולות.
דוגמאות לפעולות
בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.
דוגמה – העתקת משאב
בדוגמה הבאה אפשר לראות איך מעתיקים משאב עם נתיב שצוין לנתיב אחר:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
CopyResourceולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "From_Path": "/DropboxFolder/pptxFile.pptx", "To_Path": "/DropBoxFolder2/Folder/pptFile.pptx" }
אם הפעולה מצליחה, לפרמטר התגובה CopyResource של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[ { "Success": "true", "metadata_.tag": "file", "metadata_name": "pptxFile.pptx", "metadata_path_lower": "/testingdropboxupdated/abcde/pptxfile.pptx", "metadata_path_display": "/TestingDropBoxUpdated/abcde/pptxFile.pptx", "metadata_parent_shared_folder_id": "3204685267", "metadata_id": "id:8-07A6kHAoIAAAAAAAAC1w", "metadata_client_modified": "2024-06-13T11:06:37Z", "metadata_server_modified": "2024-07-12T10:19:02Z", "metadata_rev": "61d0a3560ecb5bf039dd3", "metadata_size": "17052", "metadata_sharing_info_read_only": "false", "metadata_sharing_info_parent_shared_folder_id": "3204685267", "metadata_sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A", "metadata_is_downloadable": "true", "metadata_content_hash": "0234f7d4eaf914cb276716c8b2a24e24655d1f6f39ee549207e33a4255e2fba2" } ]
דוגמה – יצירת תיקייה
בדוגמה הבאה אפשר לראות איך יוצרים תיקייה בנתיב נתון:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
CreateFolderולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Path": "/TestDrobBoxFolder/newFolder" }
אם הפעולה מצליחה, לפרמטר התגובה CreateFolder של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[ { "Id": "id:8-07A6kHAoIAAAAAAAAC2Q" } ]
דוגמה – מחיקת משאב
בדוגמה הבאה אפשר לראות איך מוחקים משאב:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DeleteResourceולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Path": "/TestingDropBox/FolderToBeDeletedName" }
אם הפעולה מצליחה, לפרמטר התגובה DeleteResource של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Status": "Success" }]
דוגמה – העברת משאב
בדוגמה הבאה אפשר לראות איך מעבירים משאב:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
MoveResourceולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "From_Path": "/TestDropBoxFolder/Folder1/dummypdf2.pdf", "To_Path": "/EmptyFolder/Folder1/dummypdf2.pdf" }
אם הפעולה מצליחה, לפרמטר התגובה MoveResource של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Status": "Success" }]
דוגמה – שינוי שם של משאב
בדוגמה הבאה אפשר לראות איך משנים את השם של משאב:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
RenameResourceולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Path": "/TestDropBox/abcd", "NewName": "abcded" }
אם הפעולה מצליחה, לפרמטר התגובה RenameResource של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Status": "Success" }]
דוגמה – ביטול שיתוף של תיקייה
בדוגמה הבאה אפשר לראות איך מבטלים שיתוף של תיקייה:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
UnshareFolderולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "FolderId": "3336772979" }
אם הפעולה מצליחה, לפרמטר התגובה UnshareFolder של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[{ "Status": "Success" }]
דוגמה – הורדת קובץ
בדוגמה הבאה אפשר לראות איך מורידים קובץ:
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DownloadFileולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Id": "id:8-07A6kHAoIAAAAAAAABcg", "FileType": "file" }
אם הפעולה מצליחה, לפרמטר התגובה DownloadFile של המשימה connectorOutputPayload יהיה ערך שדומה לזה:
[ { "Success": "true", "Name": "license.txt", "Id": "id:8-07A6kHAoIAAAAAAAABcg", "ClientModified": "2024-07-09T09:52:41Z", "ServerModified": "2024-07-09T09:52:41Z", "Revision": "61ccd7da2b987c0f52053", "Size": "11", "LowerCasePath": "/sahil kapoor/testingdropboxupdated/uploadfolderwithnestedfolder/nestedfolder2/license.txt", "DisplayPath": "/Sahil Kapoor/TestingDropBoxUpdated/uploadFolderWithNestedFolder/NestedFolder2/license.txt", "PreviewURL": null, "IsDownloadable": "true", "HasExplicitSharedMembers": null, "ContentHash": "f6dc724d119649460e47ce719139e521e082be8a9755c5bece181de046ee65fe", "Owner": null, "Title": null, "MimeType": null, "FileData": "SGVsbG8gd29ybGQ=", "parent_shared_folder_id": "3237290067", "sharing_info_read_only": "false", "sharing_info_parent_shared_folder_id": "3237290067", "sharing_info_modified_by": "dbid:AACVLctlrEo-ouTSxUVSTi0loZCSZKc933A" } ]
שימוש בחיבור ל-Dropbox בשילוב
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור בשילוב באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת מחברים ב-Application Integration זמין במאמר משימת מחברים.