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

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

หากต้องการเพิ่มพร็อพเพอร์ตี้ที่แอปพลิเคชันทั้งหมดมองเห็นได้ ให้ใช้ช่อง properties ของทรัพยากร files หากต้องการเพิ่มพร็อพเพอร์ตี้ที่จำกัดไว้สำหรับแอปของคุณ ให้ใช้ฟิลด์ appProperties ของทรัพยากร files

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

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

Drive API เวอร์ชัน 3

"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 รายการต่อไฟล์จากแอปพลิเคชันใดแอปพลิเคชันหนึ่ง
  • สูงสุด 124 ไบต์ต่อสตริงพร็อพเพอร์ตี้ (รวมทั้งคีย์และค่า) ในการเข้ารหัส UTF-8 เช่น พร็อพเพอร์ตี้ที่มีคีย์ยาว 10 อักขระจะมีค่าได้เพียง 114 อักขระเท่านั้น ในทํานองเดียวกัน พร็อพเพอร์ตี้ที่ต้องใช้อักขระ 100 ตัวสำหรับค่าจะใช้อักขระสำหรับคีย์ได้สูงสุด 24 ตัว

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

เข้าถึงพร็อพเพอร์ตี้ไฟล์ที่กำหนดเองแบบส่วนตัว

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