คู่มือนี้อธิบายองค์ประกอบหลักของการตอบกลับใน 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: รหัสของผู้ใช้ ซึ่งสามารถใช้กับ ผู้คน API เพื่อดูข้อมูลเพิ่มเติม
- ITEM_ID: รหัสของรายการในไดรฟ์
- TITLE: ชื่อของรายการในไดรฟ์
โปรดทราบว่า Action
ในการตอบกลับนี้ไม่รวม Actor
, Target
หรือ TimeStamp
เนื่องจากค่าเหล่านี้เหมือนกับ DriveActivity
โดยรวม
ผู้ใช้ 2 คนแก้ไขไฟล์เดียวกันในช่วงเวลาใกล้เคียงกัน
เมื่อเปิดการรวม ระบบจะจัดกลุ่มการดำเนินการที่เกี่ยวข้องไว้ด้วยกันเป็นกลุ่มเดียว
DriveActivity
ในตัวอย่างนี้ มีการรวมการดําเนินการ 2 รายการที่คล้ายกันเข้าด้วยกัน ได้แก่Edit
การดำเนินการประเภทหนึ่งจากผู้ใช้ 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: รหัสของผู้ใช้ ซึ่งสามารถใช้กับ ผู้คน API เพื่อดูข้อมูลเพิ่มเติม
- ITEM_ID_1: รหัสของรายการแรกในไดรฟ์
- ITEM_ID_2: รหัสของรายการที่ 2 ในไดรฟ์
- TITLE_1: ชื่อของรายการแรกในไดรฟ์
- TITLE_2: ชื่อของรายการที่ 2 ในไดรฟ์
โปรดทราบว่าการดําเนินการในการตอบกลับนี้จะไม่รวม Actor
หรือ TimeStamp
เนื่องจากเหมือนกันกับ DriveActivity
โดยรวม