Box

מחבר Box מאפשר לכם להתחבר לקצה העורפי של Box ולהשתמש ב-SQL כדי לאחזר ולעדכן נתונים של Box.

גרסאות נתמכות

המחבר הזה תומך בגרסה 2.0 של Box Content API.

לפני שמתחילים

לפני שמשתמשים במחבר Box, צריך לבצע את המשימות הבאות:

  • בפרויקט שלכם ב-Google Cloud:
    • מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
    • נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM‏ roles/connectors.admin.
    • מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

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

    • מפעילים את השירותים הבאים:
      • ‫secretmanager.googleapis.com (Secret Manager API)
      • ‫connectors.googleapis.com (Connectors API)

      במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.

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

הגדרת המחבר

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

  1. במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.

    כניסה לדף Connections

  2. לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
  3. בקטע מיקום, בוחרים את המיקום של החיבור.
    1. אזור: בוחרים מיקום מהרשימה הנפתחת.

      רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.

    2. לוחצים על הבא.
  4. בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
    1. מחבר: בוחרים באפשרות Box מהרשימה הנפתחת של המחברים הזמינים.
    2. גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
    3. בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.

      השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:

      • שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
      • האותיות צריכות להיות קטנות.
      • שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
      • שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
    4. אפשר גם להזין תיאור למופע החיבור.
    5. אופציונלי: מפעילים את Cloud logging ובוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-Error.
    6. חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
    7. אופציונלי: מגדירים את ההגדרות של צומת החיבור:

      • מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
      • מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.

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

    8. מצב התחברות זמנית כמשתמש אחר: מציינים את סוג ההתחברות הזמנית כמשתמש אחר. הוא צריך להיות מצב משתמש או מצב אדמין.
    9. (אופציונלי) בקטע הגדרות מתקדמות, מסמנים את התיבה שימוש ב-proxy כדי להגדיר שרת proxy לחיבור, ומגדירים את הערכים הבאים:
      • סכימת אימות של שרת proxy: בוחרים את סוג האימות לאימות מול שרת ה-proxy. יש תמיכה בסוגי האימות הבאים:
        • בסיסי: אימות HTTP בסיסי.
        • ‫Digest: אימות HTTP מסוג Digest.
      • משתמש proxy: שם משתמש שישמש לאימות בשרת ה-proxy.
      • סיסמת ה-Proxy: הסוד במנהל הסודות של סיסמת המשתמש.
      • סוג ה-SSL של ה-Proxy: סוג ה-SSL שבו יש להשתמש כשמתחברים לשרת ה-Proxy. יש תמיכה בסוגי האימות הבאים:
        • ‫Auto (אוטומטי): הגדרת ברירת המחדל. אם כתובת ה-URL היא כתובת HTTPS, נעשה שימוש באפשרות Tunnel. אם כתובת ה-URL היא כתובת HTTP, נעשה שימוש באפשרות NEVER.
        • תמיד: החיבור תמיד מופעל באמצעות SSL.
        • לעולם לא: החיבור לא מופעל באמצעות SSL.
        • מנהור: החיבור הוא דרך שרת proxy למנהור. שרת ה-proxy פותח חיבור למארח המרוחק, והתנועה זורמת הלוך ושוב דרך ה-proxy.
      • בקטע שרת Proxy, מזינים את פרטי שרת ה-Proxy.
        1. לוחצים על + הוספת יעד.
        2. בוחרים סוג יעד.
          • כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.

            כדי ליצור חיבור פרטי למערכת העורפית, פועלים לפי השלבים הבאים:

    10. אם רוצים, אפשר ללחוץ על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
    11. לוחצים על הבא.
  5. בקטע אימות, מזינים את פרטי האימות.
    1. בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.

      החיבור ל-Box תומך בסוגי האימות הבאים:

      • אימות JWT
      • ‫OAuth 2.0 – קוד הרשאה
      • קובץ JSON של Box
      • ‫OAuth 2.0 – פרטי כניסה של לקוח

      2. כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.

    2. לוחצים על הבא.
  6. בדיקה: בודקים את פרטי החיבור והאימות.
  7. לוחצים על יצירה.

הגדרת אימות

מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.

  • אימות JWT
    • מזהה לקוח: מזהה הלקוח שסופק על ידי Box לאפליקציה שיצרתם.
    • סוד הלקוח: סוד ב-Secret Manager שמכיל את סוד הלקוח של האפליקציה שיצרתם.
    • גרסת הסוד: הגרסה של סוד הלקוח.
    • מפתח פרטי: סוד ב-Secret Manager שמכיל את התוכן של קובץ המפתח הפרטי. המפתח הפרטי צריך להיות תואם למפתח הציבורי או לאישור שסופקו ל-Connector.
    • גרסת סוד: הגרסה של הסוד של המפתח הפרטי.
    • סיסמה של מפתח פרטי: הסוד ב-Secret Manager שמכיל את הסיסמה (פרפרזה) של קובץ המפתח הפרטי.
    • גרסה של סוד: הגרסה של הסיסמה של המפתח הפרטי.
    • רמת הגישה של האפליקציה ב-Box: רמת הגישה של האפליקציה ב-Box.
    • מזהה Enterprise או מזהה משתמש: מזהה Enterprise אם הרמה של האפליקציה היא Enterprise, ומזהה משתמש אם הרמה של האפליקציה היא משתמש
    • מזהה המפתח הציבורי של JWT ב-OAuth: המזהה של המפתח הציבורי של JWT.
    • Auth Scheme: Auth Scheme for the Box connector.
    • הפעלת OAuth: מפעילים את פרמטר OAuth עבור מחבר Box.
    • סוג אישור JWT של OAuth: סוג אישור JWT של OAuth למחבר Box.
  • OAuth 2.0 – קוד הרשאה
    • מזהה לקוח: מזהה הלקוח שסופק על ידי Box לאפליקציה שיצרתם.
    • היקפי הרשאות: היקפי הרשאות. לדוגמה, root_readonly. כדי להבין איך ההיקפים פועלים ולראות את כל ההיקפים שזמינים ל-Box, אפשר לעיין במאמר היקפים.
    • סוד לקוח: בוחרים באפשרות Secret Manager secret. לפני שמגדירים את ההרשאה הזו, צריך ליצור את הסוד ב-Secret Manager.
    • גרסת סוד: גרסת סוד ב-Secret Manager לסוד הלקוח.
  • Box JSON
    • ‫Box JSON for JWT Auth: הסוד שמכיל את התוכן של קובץ ה-JSON שסופק על ידי Box.
    • גרסת הסוד: הגרסה של הסוד בקובץ ה-JSON.
  • OAuth 2.0 – פרטי לקוח
    • מזהה לקוח ב-OAuth: מזהה הלקוח שסופק על ידי Box לאפליקציה שיצרתם.
    • סוד הלקוח: סוד ב-Secret Manager שמכיל את סוד הלקוח של האפליקציה שיצרתם.
    • גרסת הסוד: הגרסה של סוד הלקוח.
    • מזהה הנושא: הנושא של המשתמש שעבורו האפליקציה מבקשת גישה בהרשאה.
    • רמת הגישה של האפליקציה ב-Box: רמת הגישה של אפליקציית Box.

בסוג האימות Authorization code, אחרי שיוצרים את החיבור, צריך לבצע כמה שלבים נוספים כדי להגדיר את האימות. מידע נוסף זמין במאמר שלבים נוספים אחרי יצירת החיבור.

דוגמאות להגדרת חיבור

בקטע הזה מפורטים ערכים לדוגמה לשדות השונים שאתם מגדירים כשאתם יוצרים את החיבור.

סוג החיבור של שיטת אסימון JWT של OAuth

שם השדה פרטים
מיקום us-central1
מחבר Box
גרסת המחבר 1
שם החיבור box-conn
הפעלת Cloud Logging כן
חשבון השירות XXXX@serviceaccount
מצב התחזות למשתמש משתמש
מספר הצמתים המינימלי 2
מספר הצמתים המקסימלי 2
אימות אימות JWT
מזהה לקוח XXXX
סוד לקוח XXXX
גרסת הסוד 1
מפתח פרטי XXXX
גרסת הסוד 1
סיסמה של מפתח פרטי XXXX
גרסת הסוד 1
רמת הגישה לאפליקציית Box Enterprise
מזהה Enterprise או מזהה משתמש XXXX
מזהה המפתח הציבורי של JWT ב-OAuth XXXX
סכמת אימות OAuthJWT
הפעלת OAuth GETANDREFRESH
סוג אישור JWT של OAuth PEMKEY_BLOB

אפשר לגשת למזהה הלקוח, לסוד הלקוח, לרמת הגישה לאפליקציית Box ולמזהה הארגון או למזהה המשתמש מחשבון Box.

אפשר לגשת למפתח הפרטי ולסיסמה של המפתח הפרטי מהקובץ Private keypair.json שהורדתם. מידע נוסף זמין במאמר מידע על זוגות של מפתחות ציבוריים ופרטיים. בנוסף, לפני שמעבירים את הסיסמה של המפתח הפרטי, מחליפים את \n בקובץ json במעבר שורה חדש.

סוג החיבור של קוד הרשאה ל-OAuth

שם השדה פרטים
מיקום us-central1
מחבר Box
גרסת המחבר 1
שם החיבור box-conn
הפעלת Cloud Logging כן
חשבון השירות XXXX@serviceaccount
מצב התחזות למשתמש משתמש
הרשאה ‫OAuth 2.0 – קוד הרשאה
מספר הצמתים המינימלי 2
מספר הצמתים המקסימלי 2
מזהה לקוח XXXX
היקפים root_readwrite
סוד לקוח XXXX
גרסת הסוד 1

מידע על הגדרת OAuth ב-Box זמין במאמר יצירת אפליקציית OAuth.

קובץ JSON של Box לסוג החיבור של שיטת האימות JWT

שם השדה פרטים
מיקום us-central1
מחבר Box
גרסת המחבר 1
שם החיבור gcp-box-conn-new
הפעלת Cloud Logging כן
חשבון השירות XXXX@serviceaccount
מצב התחזות למשתמש משתמש
בתור User Id XXXX
מספר הצמתים המינימלי 2
מספר הצמתים המקסימלי 2
אימות קובץ JSON של Box
Box JSON for JWT Auth XXXX
גרסת הסוד 1

אתם יכולים להשתמש בחשבון Box כדי להגדיר Box Json לאימות JWT. למידע על הגדרת Box Json ל-JWT, אפשר לעיין במאמר שלבים ליצירת אסימון JWT .

ניגשים לערך Box Json לאימות JWT מהקובץ Private keypair.json שהורדתם. מידע נוסף זמין במאמר מידע על צמדי מפתחות ציבוריים ופרטיים. צריך להעביר את התוכן המלא של הקובץ .json בשדה Box Json for JWT Auth.

סוג החיבור OAuth Client Credentials

שם השדה פרטים
מיקום us-central1
מחבר Box
גרסת המחבר 1
שם החיבור oauth-clientcred-conn
הפעלת Cloud Logging כן
חשבון השירות XXXX@serviceaccount
מצב התחזות למשתמש משתמש
בתור User Id XXXX
מספר הצמתים המינימלי 2
מספר הצמתים המקסימלי 2
אימות פרטי כניסה של לקוח OAuth
מזהה לקוח ב-OAuth XXXX
סוד לקוח OAuth XXXX
גרסת הסוד 1
מזהה הנושא XXXX
רמת הגישה של אפליקציית Box ארגון

אפשר לגשת למזהה הלקוח, לסוד הלקוח, לרמת הגישה לאפליקציית Box ולמזהה הארגון או למזהה המשתמש מחשבון Box.

אישור מחדש של קוד הרשאה

אם אתם משתמשים בסוג האימות Authorization code וביצעתם שינויים בהגדרות באפליקציית Box, עליכם לאשר מחדש את החיבור ל-Box. כדי לחדש את הרשאת הגישה לחיבור:

  1. לוחצים על החיבור הרצוי בדף החיבורים.

    ייפתח הדף עם פרטי החיבור.

  2. לוחצים על עריכה כדי לערוך את פרטי החיבור.
  3. בודקים את הפרטים של OAuth 2.0 – קוד הרשאה בקטע אימות.

    אם צריך, מבצעים את השינויים הנדרשים.

  4. לוחצים על Save. הלחיצה תעביר אתכם לדף פרטי החיבור.
  5. בקטע אימות, לוחצים על עריכת הרשאה. מוצגת החלונית Authorize (אישור).
  6. לוחצים על Authorize.

    אם ההרשאה מתבצעת בהצלחה, סטטוס החיבור יהיה פעיל בדף החיבורים.

שלבים נוספים אחרי יצירת החיבור

אם בחרתם באפשרות OAuth 2.0 - Authorization code לאימות, אתם צריכים לבצע את השלבים הנוספים הבאים אחרי יצירת החיבור:

  1. בדף החיבורים, מאתרים את החיבור החדש.

    שימו לב שהסטטוס של המחבר החדש יהיה נדרשת הרשאה.

  2. לוחצים על דרושה הרשאה.

    יוצג לוח עריכת הרשאה.

  3. מעתיקים את הערך של Redirect URI (ה-URI של ההפניה האוטומטית) לאפליקציה החיצונית.
  4. מאמתים את פרטי ההרשאה.
  5. לוחצים על Authorize.

    אם ההרשאה מתבצעת בהצלחה, סטטוס החיבור יהיה פעיל בדף החיבורים.

ישויות, פעולות ופעולות

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

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

    עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה Entities תהיה ריקה.

  • פעולה: פעולה היא הפעילות שאפשר לבצע על ישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:

    בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה Operations.

  • פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה Actions תהיה ריקה.

פעולות

בקטע הזה מפורטות כל הפעולות שנתמכות בחיבור ל-Box.

הפעולה DownloadFile

הפעולה הזו מאפשרת להוריד קובץ ממופע Box.

פרמטרים של קלט של הפעולה DownloadFile

שם הפרמטר סוג הנתונים חובה תיאור
FileID String כן המזהה של הקובץ להורדה.
HasBytes בוליאני כן קובע אם להוריד את הקובץ כמחרוזת או כמחרוזת בקידוד Base64.

פרמטרים של פלט של הפעולה DownloadFile

הפעולה הזו מחזירה את הסטטוס 200 (OK) עם גוף תגובה שמציין את התוצאות.

שם הפרמטר סוג הנתונים תיאור
הפעולה הצליחה String ההגדרה הזו מציינת אם הורדת הקובץ הצליחה.
ContentBytes String תוכן הקובץ כמחרוזת בקידוד Base64.

דוגמאות להגדרת הפעולה DownloadFile מופיעות במאמר דוגמאות לפעולות.

הפעולה UploadFile

הפעולה הזו מאפשרת להעלות קובץ למופע Box שלכם.

פרמטרים של קלט לפעולה UploadFile

שם הפרמטר סוג הנתונים חובה תיאור
ParentID String כן המזהה של התיקייה שאליה רוצים להעלות את הקובץ. אם לא מציינים את הפרמטר הזה, הקובץ יועלה לשורש של חשבון Box. ערך ברירת המחדל הוא 0.
תוכן String כן תוכן הקובץ שרוצים להעלות.

פרמטרים של פלט של הפעולה UploadFile

הפעולה הזו מחזירה את הסטטוס 200 (OK) עם גוף תגובה שמציין את התוצאות.

שם הפרמטר סוג הנתונים תיאור
הפעולה הצליחה String מציין אם העלאת הקובץ הצליחה.
מזהה String המזהה של הקובץ החדש שנוצר.
VersionID String המזהה של גרסה ספציפית של הקובץ.
גיבוב (hash) String גיבוב SHA1 של הקובץ.
Etag String ערך ה-Etag של הקובץ או התיקייה. ערך ברירת המחדל הוא 0.

דוגמאות להגדרת הפעולה UploadFile מופיעות במאמר דוגמאות לפעולות.

הפעולה CopyFile

הפעולה הזו מאפשרת להעתיק קובץ מהמופע של Box.

פרמטרים של קלט לפעולה CopyFile

שם הפרמטר סוג הנתונים חובה תיאור
FileID String כן המזהה של הקובץ שרוצים להעתיק.
DestinationFolderId String לא המזהה של תיקיית היעד שאליה רוצים להעתיק את הקובץ. אם לא מציינים ערך, הגרסה האחרונה של הקובץ מועתקת.
NewName String כן השם החדש של הקובץ שהועתק.

פרמטרים של פלט של הפעולה CopyFile

הפעולה הזו מחזירה את הסטטוס 200 (OK) עם גוף תגובה שמציין את התוצאות.

שם הפרמטר סוג הנתונים תיאור
הפעולה הצליחה String מציין אם העתקת הקובץ הצליחה.
מזהה String המזהה של הקובץ שהועתק.

דוגמאות להגדרת הפעולה CopyFile מופיעות במאמר דוגמאות לפעולות.

פעולת CopyFolder

הפעולה הזו מאפשרת להעתיק תיקייה שלמה מהמופע של Box.

פרמטרים של הקלט של הפעולה CopyFolder

שם הפרמטר סוג הנתונים חובה תיאור
FolderID String כן המזהה של התיקייה שרוצים להעתיק.
DestinationFolderId String כן המזהה של תיקיית היעד שאליה רוצים להעתיק את התיקייה.
NewName String לא השם החדש של הקובץ לתיקייה שהועתקה.

פרמטרים של פלט של הפעולה CopyFolder

הפעולה הזו מחזירה את הסטטוס 200 (OK) עם גוף תגובה שמציין את התוצאות.

שם הפרמטר סוג הנתונים תיאור
הפעולה הצליחה String מציין אם העתקת התיקייה הצליחה.
מזהה String המזהה של התיקייה שהועתקה.

דוגמאות להגדרת הפעולה CopyFolder מופיעות במאמר דוגמאות לפעולות.

דוגמאות לפעולות

בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.

דוגמה – הורדת קובץ

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
  2. בוחרים את הפעולה DownloadFile ולוחצים על סיום.
  3. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"FileID": "1283194869422", 
"HasBytes": true
}

    4. בדוגמה הזו, קובץ מורד כמחרוזת בקידוד Base64. אם הפעולה מצליחה, לפרמטר connectorOutputPayload response של משימת המחבר יהיה ערך שדומה לערך הבא:

    [
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

דוגמה – העלאת קובץ

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
  2. בוחרים את הפעולה UploadFile ולוחצים על סיום.
  3. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"ParentId": "0",
"Content": "12345"
}

    4. בדוגמה הזו מעלים תוכן מחרוזת כקובץ. אם הפעולה מצליחה, לפרמטר connectorOutputPayload response של משימת המחבר יהיה ערך שדומה לערך הבא:

    [{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

דוגמה – העתקת קובץ

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
  2. בוחרים את הפעולה CopyFile ולוחצים על סיום.
  3. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך שדומה לערך הבא בשדה Default Value: 
    {
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}

    4. בדוגמה הזו, הקובץ עם המזהה 1288751886061 מועתק לתיקייה עם המזהה 219105724517. אם הפעולה מצליחה, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך דומה לזה:

    [{
"Success": "true",
"ID": "1308006018536"
}]

דוגמה – העתקת תיקייה

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Actions.
  2. בוחרים את הפעולה CopyFolder ולוחצים על סיום.
  3. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ואז מזינים ערך שדומה לערך הבא בשדה Default Value: 
    {
"FolderID": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}

    4. בדוגמה הזו, התיקייה עם המזהה 218475301279 מועתקת לתיקייה עם המזהה 219105724517. אם הפעולה מצליחה, לפרמטר connectorOutputPayload response במשימת המחבר יהיה ערך שדומה לערך הבא:

    [{
"Success": "true",
"ID": "226312444517"
}]

דוגמאות לפעולות על ישויות

דוגמה – הצגת כל הקבצים

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'קבצים' מהרשימה Entity.
  3. בוחרים את הפעולה LIST ולוחצים על סיום.

אפשר לבצע את הפעולה LIST על הישויות הבאות: Folders,‏ TrashedItems,‏ SharedItems,‏ Collaborations,‏ TaskAssignments ו-Tasks

דוגמה – הורדת הקבצים

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Files (קובצים) מהרשימה Entity.
  3. בוחרים את הפעולה GET ולוחצים על סיום.
  4. מגדירים את מזהה הישות ל-1262397830475, שהוא המפתח שיועבר. כדי להגדיר את מזהה הישות, בקטע Task Input של המשימה Connectors, לוחצים על EntityId ואז מזינים 1262397830475 בשדה Default Value.

הערך של מזהה הישות צריך להיות מועבר ישירות, למשל 1262397830475. כאשר 1262397830475 הוא ערך המפתח הראשי הייחודי.

אפשר לבצע את פעולת ה-GET בישויות הבאות: תיקיות, פריטים משותפים, שיתופי פעולה, הקצאות משימות ומשימות

דוגמה – מחיקת קבצים

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Files (קובצים) מהרשימה Entity.
  3. בוחרים את הפעולה DELETE ולוחצים על סיום.
  4. מגדירים את מזהה הישות ל-1258725940971, שהוא המפתח שצריך להעביר. כדי להגדיר את מזהה הישות, בקטע Task Input של המשימה Connectors, לוחצים על EntityId ואז מזינים 1258725940971 בשדה Default Value.

    לחלופין, אם לישות יש שני מפתחות עסקיים מורכבים או מפתחות ראשיים במקום לציין את entityId, אפשר גם להגדיר את filterClause ל-Id='1258725940971'.

אפשר לבצע את פעולת המחיקה על הישויות הבאות: תיקיות, משימות, שיתופי פעולה, פריטים משותפים והקצאות משימות

דוגמה – יצירת תיקיות

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'תיקיות' מהרשימה Entity.
  3. בוחרים את הפעולה Create ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Name": "Google Cloud Platforms_created_folders",
"ParentId": "0"
}

    אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של המשימה Folder יהיה ערך שדומה לזה:

     
{
"Id": "222269371053"
}

דוגמה – יצירת שיתופי פעולה

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'שיתופי פעולה' מתוך הרשימה Entity.
  3. בוחרים את הפעולה Create ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"ItemId": "216592737829",
"ItemType": "folder",
"AccessibleById": "27370766275",
"AccessibleByType": "user",
"AccessibleByLogin": "baklavainthebalkans@gmail.com",
"Role": "editor"
}

    אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של המשימה Folder יהיה ערך שדומה ל :

    {
"Success": false
}

דוגמה – יצירת משימות

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'משימות' מהרשימה Entity.
  3. בוחרים את הפעולה Create ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"ItemId": "1253997361112",
"ItemType": "file",
"Action": "review",
"Message": "Creating a task from Google Cloud Platform",
"DueAt": "2023-12-12 09:01:15.0",
"CompletionRule": "all_assignees"
}

    אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של המשימה Folder יהיה ערך שדומה לזה:

     
{
"Id": "1253997361112"
}

דוגמה – יצירת הקצאות של משימות

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות TaskAssignments מהרשימה Entity.
  3. בוחרים את הפעולה Create ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"TaskId": "21507516872",
"AssignedToId": "27370766275"
}

    אם השילוב יצליח, לפרמטר התגובה connectorOutputPayload של המשימה Folder יהיה ערך שדומה לזה:

     
{
"Id": "50804351753"
}

דוגמה – עדכון קבצים

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות Files (קובצים) מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Name": "Get Started with Box Files.pdf"
}
  5. מגדירים את מזהה הישות ל-1253997361112. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 1253997361112 בשדה Default Value.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 1253997361112.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {
"Id": "1253997361112"
}

אפשר לבצע את פעולת העדכון בישויות הבאות: תיקיות, משימות, שיתופי פעולה, פריטים משותפים והקצאות משימות

דוגמה – עדכון תיקיות

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'תיקיות' מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Name": "Demo Update"
}
  5. מגדירים את מזהה הישות ל-216457668125. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 216457668125 בשדה Default Value.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 216457668125.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {
"Id": "216457668125"
}

דוגמה – עדכון שיתופי פעולה

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'שיתופי פעולה' מתוך הרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Role": "Viewer"
}
  5. מגדירים את מזהה הישות ל-46685648757. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 46685648757 בשדה Default Value.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 46685648757.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {

}

דוגמה – עדכון משימות

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'משימות' מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Message": "This is a new task is updated and assigned to you by me"
}
  5. מגדירים את מזהה הישות ל-21507516872. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 21507516872 בשדה Default Value.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 21507516872.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {
"Id": "21507516872"
}

דוגמה – עדכון של taskassignments

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות TaskAssignments מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Message": "Looks good to me",
"ResolutionState": "completed"
}
  5. מגדירים את מזהה הישות ל-49542929469. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 49542929469 בשדה Default Value.

    לחלופין, במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך 49542929469.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {
"Id": "49542929469"
}

דוגמה – עדכון של Transferfolders

  1. בתיבת הדו-שיח Configure connector task, לוחצים על Entities.
  2. בוחרים באפשרות 'תיקיות' מהרשימה Entity.
  3. בוחרים את הפעולה Update ולוחצים על סיום.
  4. בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על connectorInputPayload ומזינים ערך דומה לערך הבא בשדה Default Value: 
    {
"Name": "Demo Update"
"ParentId": "216596059374"
}
  5. מגדירים את מזהה הישות ל-216457668125. כדי להגדיר את מזהה הישות, לוחצים על entityId ואז מזינים 216457668125 בשדה Default Value.

    הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט connectorOutputPayload של משימת המחבר:

    {
"Id": "216457668125"
}

יצירת חיבורים באמצעות Terraform

אפשר להשתמש במשאב של Terraform כדי ליצור חיבור חדש.

כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.

כדי לראות תבנית לדוגמה של Terraform ליצירת חיבור, אפשר לעיין בתבנית לדוגמה.

כשיוצרים את החיבור הזה באמצעות Terraform, צריך להגדיר את המשתנים הבאים בקובץ ההגדרות של Terraform:

שם הפרמטר סוג נתונים חובה תיאור
impersonate_user_mode ENUM True מציינים את סוג ההתחברות הזמנית כמשתמש אחר. הוא צריך להיות מצב משתמש או מצב אדמין. הערכים הנתמכים הם: User, Admin
proxy_enabled בוליאני לא נכון מסמנים את תיבת הסימון הזו כדי להגדיר שרת Proxy לחיבור.
proxy_auth_scheme ENUM לא נכון סוג האימות שמשמש לאימות לשרת ה-proxy‏ ProxyServer. הערכים הנתמכים הם: BASIC, ‏ DIGEST, ‏ NONE
proxy_user מחרוזת לא נכון שם משתמש שישמש לאימות בשרת ה-proxy ‏ProxyServer.
proxy_password SECRET לא נכון סיסמה שתשמש לאימות בשרת ה-proxy‏ ProxyServer.
proxy_ssltype ENUM לא נכון סוג ה-SSL שבו צריך להשתמש כשמתחברים לשרת ה-proxy של ProxyServer. הערכים הנתמכים הם: AUTO, ‏ ALWAYS, ‏ NEVER, ‏ TUNNEL

שימוש בחיבור Box בשילוב

אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור באינטגרציה באמצעות המשימה Connectors.

  • כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
  • מידע על יצירה ושימוש במשימת Connectors ב-Application Integration זמין במאמר משימת Connectors.

קבלת עזרה מקהילת Google Cloud

אתם יכולים לפרסם את השאלות שלכם ולדון במחבר הזה בקהילת Google Cloud בפורומים של Cloud.

המאמרים הבאים