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

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

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

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

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

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

ממשק API של Drive גרסה 3

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

ממשק API של Drive גרסה 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. למידע נוסף, ראו הוספת מאפיינים מותאמים אישית.

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

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

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

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

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

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

כדי למחוק את ערכי המאפיינים שגלויים לכל האפליקציות, משתמשים ב-method 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. לגרסה 2 של Drive API, עיינו במידע על properties.

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

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