เพิ่มพร็อพเพอร์ตี้ของไฟล์ที่กําหนดเอง

คุณสมบัติของไฟล์ที่กำหนดเองคือคู่คีย์-ค่าที่ใช้ในการจัดเก็บข้อมูลเมตาที่กำหนดเองสำหรับไฟล์ Google ไดรฟ์ (เช่น แท็ก) รหัสจากพื้นที่เก็บข้อมูลอื่นๆ ข้อมูลที่แชร์ระหว่างแอปพลิเคชันเวิร์กโฟลว์ และอื่นๆ เช่น คุณสามารถเพิ่มคุณสมบัติไฟล์ ให้กับเอกสารทั้งหมดที่ฝ่ายขายสร้างขึ้นในไตรมาสที่ 1

หากต้องการเพิ่มพร็อพเพอร์ตี้ที่แอปพลิเคชันทั้งหมดมองเห็นได้ ให้ใช้ช่อง properties ของทรัพยากร files หากต้องการเพิ่มพร็อพเพอร์ตี้ที่จํากัดเฉพาะแอปของคุณ ให้ใช้ช่อง appProperties ของแหล่งข้อมูล files

คุณยังใช้พร็อพเพอร์ตี้ในนิพจน์การค้นหาได้ด้วย

นี่คือโครงสร้างของพร็อพเพอร์ตี้ทั่วไปที่อาจใช้จัดเก็บรหัสฐานข้อมูลของไฟล์ในไดรฟ์ในไฟล์

API ไดรฟ์ v3

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

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"
  }
}

คุณสามารถเพิ่มคุณสมบัติที่กำหนดเองลงในไฟล์โดยใช้บริการไดรฟ์ขั้นสูงใน 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
}

หากต้องการดูการเปลี่ยนแปลง ให้เรียกใช้เมธอด files.get เพื่อเรียกออบเจ็กต์ properties สำหรับไฟล์

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

ขีดจํากัดของพร็อพเพอร์ตี้ไฟล์ที่กําหนดเอง

พร็อพเพอร์ตี้ที่กำหนดเองมีขีดจำกัดดังต่อไปนี้

  • พร็อพเพอร์ตี้ที่กําหนดเองสูงสุด 100 รายการต่อไฟล์ ซึ่งรวมมาจากแหล่งที่มาทั้งหมด
  • พร็อพเพอร์ตี้สาธารณะสูงสุด 30 รายการต่อไฟล์ ซึ่งรวมมาจากแหล่งที่มาทั้งหมด
  • พร็อพเพอร์ตี้ส่วนตัวสูงสุด 30 รายการต่อไฟล์จากแอปพลิเคชัน 1 รายการ
  • สูงสุด 124 ไบต์ต่อสตริงพร็อพเพอร์ตี้ (รวมทั้งคีย์และค่า) ในการเข้ารหัส UTF-8 เช่น พร็อพเพอร์ตี้ที่มีคีย์ยาว 10 อักขระจะมีค่าได้เพียง 114 อักขระ ในทำนองเดียวกัน พร็อพเพอร์ตี้ที่กำหนดให้ค่ามีอักขระ 100 ตัวจะใช้คีย์ได้สูงสุด 24 อักขระ

ดูข้อมูลเพิ่มเติมได้ในแหล่งข้อมูล files สำหรับ Drive API v2 โปรดดูทรัพยากร properties

เข้าถึงคุณสมบัติส่วนตัวของไฟล์ที่กำหนดเอง

คุณจะเรียกพร็อพเพอร์ตี้ส่วนตัวโดยใช้ช่อง appProperties ได้ผ่านคำขอที่ตรวจสอบสิทธิ์แล้วซึ่งใช้โทเค็นเพื่อการเข้าถึงที่ได้รับด้วยรหัสไคลเอ็นต์ OAuth 2.0 คุณใช้คีย์ API เพื่อเรียกข้อมูลพร็อพเพอร์ตี้ส่วนตัวไม่ได้