โมเดลข้อมูล API กิจกรรมในไดรฟ์

คู่มือนี้จะอธิบายองค์ประกอบหลักของคำตอบใน Google Drive Activity API โดยจะแสดงตัวอย่างและวิธีตีความคำตอบ

วัตถุ

  • DriveActivity — นี่คือทรัพยากรหลักที่ส่งกลับจากการค้นหาไปยัง Drive Activity API ซึ่งอธิบายผู้ดำเนินการ 1 คนขึ้นไปที่ดำเนินการอย่างน้อย 1 อย่างที่ส่งผลกระทบต่อเป้าหมาย 1 ข้อขึ้นไป

  • Timestamp และ TimeRange — ซึ่งอธิบายจากช่วงเวลาหนึ่งเวลาที่กิจกรรมเกิดขึ้น หรือจุดเริ่มต้นและสิ้นสุดเวลาที่กิจกรรมเกิดขึ้นในช่วงระยะเวลาหนึ่ง

  • Actor - โดยปกติแล้ว Actor คือผู้ใช้ปลายทาง อย่างไรก็ตาม บางครั้งเหตุการณ์ของระบบอาจทริกเกอร์ Action เมื่อผู้ดูแลระบบทำหน้าที่เป็นผู้ใช้หรือในฐานะตนเอง หรือเมื่อดำเนินการโดยบุคคลที่ระบุตัวตนไม่ได้ ข้อความ Actor จะสรุปกรณีเหล่านี้แต่ละกรณี

  • Target - Target คือออบเจ็กต์ของกิจกรรม เช่น ไฟล์ โฟลเดอร์ ไดรฟ์ที่แชร์ หรือความคิดเห็นในไฟล์ โปรดทราบว่าประเภทการกระทำหลายประเภทรองรับเป้าหมายมากกว่า 1 ประเภท ตัวอย่างเช่น แม้ว่าโดยทั่วไปแล้ว Edit จะมีผลกับไฟล์ในไดรฟ์ แต่การดำเนินการอื่นๆ อย่าง Rename และ Create ก็อาจมีผลกับโฟลเดอร์ไดรฟ์และไดรฟ์ที่แชร์ได้เช่นกัน เป้าหมายที่ไม่ใช่รายการในไดรฟ์จะยังคงอ้างอิงถึงรายการเดียวได้ เช่น โฟลเดอร์รูทของไดรฟ์หรือเอกสารหลักที่มีความคิดเห็นในไฟล์

  • Action - ทรัพยากร DriveActivity แต่ละรายการมีการดำเนินการที่เกี่ยวข้องอย่างน้อย 1 รายการ Action อยู่ในตัวเองเช่นเดียวกับเหตุการณ์ กล่าวคือไม่ได้มีเพียงประเภทและข้อมูลโดยละเอียดเกี่ยวกับการดำเนินการเท่านั้น แต่ยังรวมถึง Actor, Target และ Timestamp หรือ TimeRange ด้วย เพื่อหลีกเลี่ยงความซ้ำซ้อน Action จะไม่ป้อนข้อมูลในช่อง Target, Actor หรือเวลาของตนเองเมื่อช่องดังกล่าวเหมือนกับ DriveActivity โดยรวม

  • ActionDetail คือประเภทเฉพาะและข้อมูลโดยละเอียดเกี่ยวกับ Action ตัวอย่างเช่น รายละเอียดการดำเนินการ Move จะมีตำแหน่งต้นทางและปลายทาง และ PermissionChange จะระบุผู้ที่มีสิทธิ์เข้าถึงเอกสารและสิทธิ์ต่างๆ

คำตอบตัวอย่าง

ผู้ใช้แก้ไขไฟล์ในไดรฟ์

ทรัพยากร DriveActivity แบบง่ายอาจมีการดำเนินการเพียงอย่างเดียว เช่น ผู้ใช้แก้ไขไฟล์ 1 รายการ

"activities":[{
  "primary_action_detail":{ "edit":{} },
  "actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
  "targets":[ { "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } } ],
  "timestamp":{ "seconds":"1536794657", "nanos":791000000 },
  "actions":[ { "detail":{ "edit":{} } } ]
}]

ผลลัพธ์นี้ประกอบด้วยค่าต่อไปนี้

  • ACCOUNT_ID: รหัสของผู้ใช้ ซึ่งใช้ร่วมกับ People API ได้เพื่อรับข้อมูลเพิ่มเติม
  • ITEM_ID: รหัสของรายการในไดรฟ์
  • TITLE: ชื่อรายการในไดรฟ์

โปรดทราบว่า Action ในการตอบกลับนี้ไม่รวม Actor, Target หรือ TimeStamp เนื่องจากเหมือนกันกับ DriveActivity โดยรวม

ผู้ใช้ 2 คนแก้ไขไฟล์เดียวกันในเวลาไล่เลี่ยกัน ดังนี้

เมื่อเปิดการรวม การดําเนินการที่เกี่ยวข้องจะจัดกลุ่มเป็น DriveActivity เดียว ในตัวอย่างนี้ มีการจัดกลุ่มการกระทำที่คล้ายกัน 2 ประเภท ได้แก่ ประเภทการดำเนินการ Edit 1 ประเภทจากผู้ใช้ 2 ราย

"activities":[{
  "primary_action_detail":{ "edit":{} },
  "actors":[
    { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
    { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } }
  ],
  "targets":[
    { "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } }
  ],
  "time_range":{
    "start_time":{ "seconds":"1541089823", "nanos":712000000 },
    "end_time":{ "seconds":"1541089830", "nanos":830000000 }
  },
  "actions":[
    {
      "detail":{ "edit":{} },
      "actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
      "timestamp":{ "seconds":"1541089830", "nanos":830000000 }
    },
    {
      "detail":{ "edit":{} },
      "actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } },
      "timestamp":{ "seconds":"1541089823", "nanos":712000000 }
    }
  ]
}]

ผลลัพธ์นี้ประกอบด้วยค่าต่อไปนี้

  • ACCOUNT_ID_1: รหัสของผู้ใช้รายแรก ซึ่งใช้ร่วมกับ People API ได้ เพื่อรับข้อมูลเพิ่มเติม
  • ACCOUNT_ID_2: รหัสของผู้ใช้คนที่ 2
  • ITEM_ID: รหัสของรายการในไดรฟ์
  • TITLE: ชื่อรายการในไดรฟ์

โปรดทราบว่าการดำเนินการในคำตอบนี้ไม่รวม Target เนื่องจากเหมือนกันกับ DriveActivity โดยรวม

ตัวอย่างนี้ยังแสดงให้เห็นวิธีที่แอปอาจใช้เฉพาะข้อมูลสรุปใน DriveActivity โดยไม่ดูการดำเนินการแต่ละรายการ คำตอบระบุว่าผู้ใช้ 2 คนแก้ไขไฟล์หนึ่งๆ ในช่วงเวลาหนึ่ง

ผู้ใช้ย้ายไฟล์ 2 ไฟล์ไปยังไดเรกทอรีใหม่

ในตัวอย่างนี้ กลยุทธ์การรวมได้จัดกลุ่มการดำเนินการ Move ที่เกี่ยวข้อง 2 รายการ เนื่องจากย้ายไฟล์จากแหล่งที่มาเดียวกันไปยังปลายทางเดียวกันในเวลาเดียวกัน

"activities":[{
  "primary_action_detail":{
    "move":{
      "added_parents":[ { ... } ]
      "removed_parents":[ { ... } ]
    }
  },
  "actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
  "targets":[
    { "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } },
    { "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
  ],
  "timestamp":{ "seconds":"1541090960", "nanos":985000000 },
  "actions":[
    {
      "detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
      "target":{ "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } }
    },
    {
      "detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
      "target":{ "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
    }
  ]
}]

ผลลัพธ์นี้ประกอบด้วยค่าต่อไปนี้

  • ACCOUNT_ID: รหัสของผู้ใช้ ซึ่งใช้ร่วมกับ People API ได้เพื่อรับข้อมูลเพิ่มเติม
  • ITEM_ID_1: รหัสของรายการแรกในไดรฟ์
  • ITEM_ID_2: รหัสของรายการในไดรฟ์ที่ 2
  • TITLE_1: ชื่อของรายการแรกในไดรฟ์
  • TITLE_2: ชื่อรายการในไดรฟ์ที่ 2

โปรดทราบว่าการดำเนินการในคำตอบนี้ไม่รวม Actor หรือ TimeStamp เนื่องจากเหมือนกันกับ DriveActivity โดยรวม