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

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

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

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

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

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

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

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

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

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

כדי להוסיף או לעדכן מאפיינים שגלויים לכל האפליקציות, משתמשים ב-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 כדי לאחזר נכסים פרטיים.