מבוא ל-Google Drive Activity API

במסמך הזה מפורטת סקירה כללית על Google Drive Activity API.

ממשק Drive Activity API מאפשר לכם לשלוח שאילתות לגבי אירועים מהזמן האחרון. אתם יכולים לאחזר היסטוריה מפורטת של כל הפעילויות, כולל מידע מפורט על כל אירוע. האפשרות הזו שימושית למשימות כמו ביקורות, כי אפשר לאחזר פעילויות מדויקות שכוללות את המידע ActionDetail, Actor ו-Target.

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

בקשה

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

תשובה

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

הסבר על הודעת גוף התגובה של Drive Activity API.
איור 1. הסבר על הודעת גוף התגובה של Drive Activity API.

משאב DriveActivity הוא אוסף של אובייקטים Action, שכל אחד מהם הוא עצמאי כמו אירוע. ‫Action כולל ActionDetail (כמו Create או Edit), Actor (כמו User או Administrator), Target (כמו DriveItem או Drive) וגם Timestamp או TimeRange.

משאב DriveActivity מכיל גם מידע סיכום, כמו כל Actor וTarget מכל הפעולות, Timestamp או TimeRange מאוחדים, וגם את ActionDetail החשוב או המייצג ביותר מתוך Action.

מידע נוסף זמין במאמר בנושא מודל הנתונים של Drive Activity API.

הרשאות הגישה להיסטוריית הפעילות

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

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

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

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

  • אם מסמך אף פעם לא שותף עם משתמש, הוא לא יכול לראות את היסטוריית הפעילות.

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