הרשמה לאירועים ב-Google Drive

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

מידע נוסף על פיתוח אפליקציות ל-Drive זמין במאמר סקירה כללית על Google Drive API.

אירועים נתמכים ב-Drive

מינויים ל-Google Workspace מאפשרים לכם לקבל אירועים לגבי סוגי השינויים הבאים ב-Drive:

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

משאבים שאפשר לעקוב אחרי אירועים שקשורים אליהם

כדי לקבל אירועים, צריך לציין משאב ב-Drive למעקב, שנקרא משאב היעד של המינוי.

‫Google Workspace Events API תומך במשאבי היעד הבאים עבור Drive:

סוגי אירועים ליצירת מינויים

כשיוצרים מינוי למשאב ב-Drive, משתמשים בשדה eventTypes[] כדי לציין אילו סוגי אירועים רוצים לקבל. סוגי האירועים מעוצבים בהתאם למפרט CloudEvents, כמו google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

לדוגמה, כדי לקבל אירועים לגבי קובץ שנוצר בתיקייה או בכונן משותף, מציינים את הקובץ כמשאב היעד ואת סוג האירוע כ-google.workspace.drive.file.v3.created. כדי לקבל אירועים לגבי יצירת הצעה לגישה לקובץ, צריך לציין את ההצעה לגישה כמשאב היעד ואת סוג האירוע כ-google.workspace.drive.accessproposal.v3.created. מידע נוסף על אופן הפעולה של אירועים זמין במאמר מבנה האירועים ב-Google Workspace.

בטבלה הבאה מוצגים סוגי האירועים שנתמכים במינויים למשאבי Drive:

נתוני אירוע

בקטע הזה מתוארים נתוני אירועים ומטענים לדוגמה של אירועים ב-Drive.

כשמתקבל אירוע מ-Drive במינוי ל-Google Workspace, השדה data מכיל את מטען הייעודי (payload) של האירוע. המטען הייעודי (payload) הזה מכיל מידע על משאב Google Workspace שהשתנה. לדוגמה, אם נרשמתם לאירועים שקשורים לקבצים, מטען הייעודי (payload) של האירועים האלה מכיל מידע על משאב file שהשתנה.

נתוני משאבים במטען הייעודי של האירוע

כשיוצרים מינוי, אפשר לציין אם רוצים שהמטען הייעודי (Payload) יכלול פרטים על המשאב, או רק את השם של המשאב. לדוגמה, אם רוצים לקבל אירועים לגבי קבצים ב-Drive, אפשר לציין אילו שדות של files משאב רוצים לקבל במטען הייעודי (payload) של האירוע.

בטבלה הבאה מופיעות דוגמאות למטענים ייעודיים (payloads) של JSON להרשמה למשאב Drive. מזהה הקובץ מכיל אותיות, מספרים ותווים מיוחדים מסוימים במבנה files/^[01][0-9a-zA-Z_-]+$/. לדוגמה, files/1aaabbbAAABBB111222-_. לכל אירוע שהמינוי מקבל, מטען הייעודי (payload) מופיע בשדה data של האירוע:

{
  "fileCreatedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileCreatedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "fileMovedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileMovedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "fileContentChangedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileContentChangedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "fileDeletedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileDeletedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "fileTrashedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileTrashedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "fileUntrashedEvent": {
    "file": {
      "id": "FILE_ID",
      "parent": "PARENT_ID",
      "version": "63",
      "mimeType": "application/vnd.google-apps.document"
    }
  }
}
      

{
  "fileUntrashedEvent": {
    "file": {
      "id": "FILE_ID"
    }
  }
}
      

{
  "accessProposalCreatedEvent": {
    "accessProposal": [
      {
        "file_id": "FILE_ID",
        "proposalId": "PROPOSAL_ID",
        "recipientEmailAddress": "63",
        "requesterEmailAddress": "application/vnd.google-apps.document",
        "requestMessage": "grant me access to this file",
        "rolesAndViews": [
          {
            "role": "writer",
            "view": "published"
          }
        ]
      }
    ]
  }
}
      

{
  "accessProposalCreatedEvent": {
    "accessProposal": [
      {
        "proposalId": "PROPOSAL_ID"
      }
    ]
  }
}
      

{
  "accessProposalResolvedEvent": {
    "accessProposal": [
      {
        "file_id": "FILE_ID",
        "proposalId": "PROPOSAL_ID",
        "recipientEmailAddress": "63",
        "requesterEmailAddress": "application/vnd.google-apps.document",
        "requestMessage": "resolve access to this file",
        "rolesAndViews": [
          {
            "role": "writer",
            "view": "published"
          }
        ]
      }
    ]
  }
}
      

{
  "accessProposalResolvedEvent": {
    "accessProposal": [
      {
        "proposalId": "PROPOSAL_ID"
      }
    ]
  }
}
      

• כשהשדה הבוליאני includeDescendants ב- DriveOptions הוא true, מינויים ל-Drive בתיקיות ובתיקיות אחסון שיתופי תמיד שולחים אירוע, גם אם הקובץ שהפעיל את האירוע נמצא ברמה נמוכה יותר בתיקייה שמשמשת למינוי ל-Drive.
• יכול להיות שיצרתם מינוי לתיקייה, אבל לא תקבלו את כל האירועים בהיררכיית הקבצים כי יכול להיות שלא ניתנה למשתמש או לאפליקציה גישה אליהם. במקרה כזה, המינוי יישאר פעיל אבל לא תקבלו אירועים לגבי משאבים שאין לכם גישה אליהם.
• המנויים נתמכים לאירועים בכל הקבצים והתיקיות, אבל לא בתיקיית הבסיס של אחסונים שיתופיים. אפשר להירשם לעדכונים רק לגבי קבצים ותיקיות באחסון שיתופי. שינויים שמתבצעים ישירות בתיקיית הבסיס של תיקיות באחסון השיתופי לא יפעילו אירועים.
• למשתמש שמאשר את המינוי צריכה להיות הרשאה בקובץ שמתאים לאירועים שהוא נרשם לקבלת עדכונים לגביהם.
• המינוי מקבל רק אירועים של משאבים שהמשתמש יכול לגשת אליהם דרך חשבון Google Workspace או חשבון Google שלו.

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

• סקירה כללית של Google Workspace Events API
• המבנה של אירועים ב-Google Workspace
• בחירת היקפי ההרשאות של Google Workspace Events API
• בחירת היקפי הרשאות של Google Drive API