מעבר מ-Drive Activity API גרסה 1

במדריך הזה מוסבר מה ההבדל בין Google Drive Activity API v1 ל-v2, ואיך לשנות את האפליקציה שלכם בגרסה v1 כך שתתמוך ב-API v2.

אישור

ב-API בגרסה 1 נעשה שימוש בהיקף הזה:

  • https://www.googleapis.com/auth/activity

ב-API v2 נדרש אחד מההיקפים הבאים:

  • https://www.googleapis.com/auth/drive.activity
  • https://www.googleapis.com/auth/drive.activity.readonly

שמות המשאבים

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

בדרך כלל אפשר להמיר את המזהים האלה. לדוגמה, הפנייה לפריטים ב-Drive ב-API v2 מתבצעת באמצעות שם המשאב items/ITEM_ID_V1.

בקשות

הפורמט של הבקשה בגרסה 2 דומה לפורמט של הבקשה בגרסה 1. באופן ספציפי, עדיין אפשר לבקש פעילות של קובץ ב-Drive או של אב קדמון ב-Drive, אבל חשוב לזכור שצריך לעצב את פרמטרים הבקשה האלה כשמות משאבים על ידי הוספת הקידומת items/.

האפשרות 'קיבוץ' נקראת עכשיו איחוד, והפרמטרים של הבקשה source ו-userId הוסרו.

יש גם אפשרויות חדשות של מסנן שמאפשרות להגביל את סוגי נתוני הפעילות שמוחזרים בתגובה.

פעולות

ב-API בגרסה 1, סוג הפעילות והנתונים המשויכים לפעילות הזו היו בשדות נפרדים. לדוגמה, אם השדה primaryEventType מכיל את הערך move, האפליקציות יקבלו את ההנחה שהשדה move ברמה העליונה מאוכלס בהורים שנוספו והוסרו.

ב-API v2, השדות האלה כבר לא נבדלים זה מזה. להודעה ActionDetail מוגדר שדה אחד בלבד. הוא מציין את סוג הפעולה ומכיל את הפרטים שמשויכים לפעולה הזו. לדוגמה, ActionDetail שמייצג תנועה מגדיר רק את השדה move, והשדה הזה מציג את ההורים שנוספו והוסרו.

השדה primaryEventType ב-API בגרסה 1 תואם בערך לשדה primaryActionDetail ב-API בגרסה 2.

Actors

ב-API בגרסה 1, הפעילות שחוזרת מכילה את הערך User אם הגורם המבצע היה משתמש ידוע, ואפשרותית מכילה שדה ברמה העליונה כמו fromUserDeletion במקרים מיוחדים.

ב-API בגרסה 2 זמינה קבוצה עשירה יותר של סוגי Actor, והשדה user.knownUser מאוכלס כשהגורם המבצע הוא משתמש ידוע. אם האפליקציה שלכם זקוקה למידע מפורט על משתמשים, תוכלו לשלוח שאילתה ל-People API על ידי העברת השדה KnownUser personName לשיטה people.get.

יעדים

ב-API בגרסה 1, היעדים תמיד היו פריטים ב-Drive. ב-API v2, היעד יכול להיות סוגים אחרים של אובייקטים ב-Drive. לדוגמה, לשינויים בכונן יש סוג יעד של Drive. תיקיית השורש של האחסון השיתופי עדיין תוחזר (כDriveItem בשדה root), אבל היא לא היעד המיידי של הפעילות. רעיון דומה חל על משאב FileComment, שהשדה parent שלו מתייחס לפריט ב-Drive שמכיל את שרשור התגובות היעד.

פעילות מאוחדת

ב-API בגרסה 1, סגנון התגובה השתנה כשהוגדר אסטרטגיית איחוד ('קיבוץ'). באופן ספציפי, כשהאיחוד היה מופעל, כל פעילות הכילה את האירוע המורכב singleEvents ואירוע combinedEvent שסיכם את הפעילות המשותפת בין האירועים המרכיבים. כשהאיחוד היה מושבת, השדה combinedEvent הכיל את האירוע המקורי ללא איחוד לכל פעילות. כל אחד מהאירועים האלה יכול לייצג יותר מפעולה אחת, למשל יצירה בשילוב עם שיתוף.

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