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

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

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

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

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

Drive API v3

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

Drive API v2

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

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

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

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

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