הוספת מאפיינים מותאמים אישית של קובץ

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

כדי להוסיף מאפיינים שגלויים לכל האפליקציות, משתמשים בשדה properties של המשאב files. כדי להוסיף מאפיינים שמוגבלים לאפליקציה, משתמשים בשדה appProperties במשאב files.

הערה: אם משתמשים בגרסה הישנה יותר של Google Drive API (v2), כדאי להשתמש במשאב properties כדי להוסיף מאפיינים לאפליקציה באמצעות properties.insert. רשימה מלאה של ההבדלים בין הגרסאות מופיעה בחומר העזר בנושא השוואה בין Drive API v2 ו-v3.

אפשר להשתמש במאפיינים גם בביטויי חיפוש.

זהו המבנה של מאפיין אופייני שיכול לשמש לאחסון מזהה מסד נתונים של קובץ ב-Drive בקובץ.

Drive API גרסה 3

"appProperties": {
  "additionalID": "ID",
}

Drive API גרסה 2

{
  'key':        'additionalID',
  'value':      'ID',
  'visibility': 'PRIVATE'
}

עבודה עם מאפייני קבצים מותאמים אישית

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

הערה: בממשק המשתמש של Google Drive אין דרך מובנית לערוך מאפיינים מותאמים אישית.

הוספה או עדכון של מאפייני קובץ מותאמים אישית

כדי להוסיף או לעדכן מאפיינים שגלויים לכל האפליקציות, משתמשים ב-method files.update כדי להגדיר את השדה properties של המשאב files.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

תוכלו גם להוסיף מאפיין מותאם אישית לקובץ באמצעות שירות Drive המתקדם ב-Google Apps Script. למידע נוסף, קראו את המאמר הוספת מאפיינים מותאמים אישית.

אחזור או פירוט של מאפייני קובץ מותאמים אישית

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

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

התגובה מורכבת מאובייקט properties שמכיל אוסף של צמדי מפתח/ערך.

{
  "properties": {
    "name": "wrench",
    "mass": "1.3kg",
    "count": "3"
  }
}

מחיקת מאפייני קובץ מותאמים אישית

כדי למחוק ערכי מאפיינים שגלויים לכל האפליקציות, משתמשים בשיטה files.update כדי להגדיר את השדה properties במשאב files כ-null.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

כדי לצפות בשינוי, קוראים ל-method files.get כדי לאחזר את האובייקט properties של הקובץ.

{
  "properties": {
    "mass": "1.3kg",
    "count": "3"
  }
}

המגבלות של מאפייני קבצים מותאמים אישית

על נכסים מותאמים אישית חלות המגבלות הבאות:

• עד 100 מאפיינים מותאמים אישית לקובץ, סה"כ מכל המקורות.
• עד 30 נכסים ציבוריים לקובץ, סה"כ מכל המקורות.
• עד 30 נכסים פרטיים לקובץ מכל אפליקציה אחת.
• עד 124 בייטים לכל מחרוזת מאפיין (כולל מפתח וערך) בקידוד UTF-8. לדוגמה, נכס עם מפתח באורך של 10 תווים יכול להכיל רק 114 תווים. באופן דומה, מאפיין שדורש 100 תווים בערך יכול להשתמש ב-24 תווים לכל היותר במפתח.

מידע נוסף מופיע במשאב files. למידע על Drive API v2, ראו properties.

גישה למאפיינים של קבצים פרטיים בהתאמה אישית

אפשר לאחזר מאפיינים פרטיים רק באמצעות השדה appProperties, באמצעות בקשה מאומתת שמשתמשת באסימון גישה שהתקבל עם מזהה לקוח OAuth 2.0. לא ניתן להשתמש במפתח API כדי לאחזר נכסים פרטיים.