Nhận xét là ý kiến phản hồi do người dùng cung cấp về một tệp, chẳng hạn như trình đọc tài liệu xử lý văn bản đề xuất cách diễn đạt lại một câu. Có hai loại nhận xét: nhận xét được liên kết và nhận xét không được liên kết. Chú thích được neo được liên kết với một vị trí cụ thể, chẳng hạn như một câu trong tài liệu xử lý văn bản, trong một phiên bản cụ thể của tài liệu. Ngược lại, một nhận xét không liên kết chỉ được liên kết với tài liệu.
Phản hồi được đính kèm vào nhận xét và thể hiện phản hồi của người dùng về nhận xét. API Drive cho phép người dùng thêm nhận xét và phản hồi vào các tài liệu do ứng dụng của bạn tạo. Nhìn chung, một nhận xét có các phản hồi được gọi là cuộc thảo luận.
Thêm bình luận không liên kết
Để thêm một nhận xét không liên kết vào tài liệu, hãy gọi phương thức comments.create bằng tham số fileId và tài nguyên comments chứa nhận xét.
Chú thích được chèn dưới dạng văn bản thuần tuý, nhưng nội dung phản hồi cung cấp một trường htmlContent chứa nội dung được định dạng để hiển thị.
Thêm phản hồi cho bình luận
Để thêm một câu trả lời cho một nhận xét, hãy gọi phương thức replies.create với nhận xét, tham số fileId và tài nguyên replies chứa câu trả lời.
Nội dung trả lời được chèn dưới dạng văn bản thuần tuý, nhưng nội dung phản hồi cung cấp một trường htmlContent chứa nội dung được định dạng để hiển thị.
Thêm một nhận xét liên kết vào bản sửa đổi mới nhất của tài liệu
Khi thêm nhận xét, bạn có thể liên kết nhận xét đó với một vùng trong tệp. Neo xác định bản sửa đổi tệp và vùng trong tệp mà nhận xét tham chiếu đến. Tài nguyên comments xác định trường anchor dưới dạng một chuỗi JSON.
Cách thêm bình luận được liên kết:
(Tùy chọn). Gọi phương thức
revisions.listđể liệt kê mọirevisionIDcho một tài liệu. Chỉ làm theo bước này nếu bạn muốn liên kết một bình luận với bất kỳ bản sửa đổi nào khác ngoài bản sửa đổi mới nhất. Nếu bạn muốn sử dụng bản sửa đổi mới nhất, hãy sử dụngheadchorevisionID.Gọi phương thức
comments.createbằng tham sốfileID, tài nguyêncommentschứa nhận xét và chuỗi neo JSON chứarevisionID(r) và vùng (a).
Cách bạn xác định một vùng phụ thuộc vào loại nội dung tài liệu mà bạn đang xử lý. Để biết thêm thông tin, hãy tham khảo bài viết Xác định khu vực.
Xác định khu vực
Như đã đề cập trước đó, chuỗi neo JSON chứa revisionID (r) và vùng (a). Vùng (a) là một mảng JSON chứa các thuật toán phân loại vùng chỉ định định dạng và vị trí neo một nhận xét. Thuật toán phân loại có thể là một hình chữ nhật hai chiều cho một hình ảnh, một dòng văn bản trong tài liệu hoặc thời lượng trong video. Để xác định một khu vực, hãy chọn trình phân loại khu vực khớp với loại nội dung mà bạn đang cố gắng neo vào. Ví dụ: nếu nội dung của bạn là văn bản, bạn có thể sử dụng thuật toán phân loại khu vực txt hoặc line.
Để biết danh sách các thuật toán phân loại khu vực trong API Drive, hãy tham khảo phần Thuật toán phân loại khu vực.
Ví dụ sau đây cho thấy một chuỗi neo JSON neo các nhận xét vào các dòng trong hai khu vực riêng biệt của một tài liệu:
- Khu vực đầu tiên bắt đầu từ dòng 12 (
'n':12) và kéo dài trong 3 dòng ('l':3). - Khu vực thứ hai chỉ bao gồm dòng 18 (
'n':18, 'l':1`).
{
'r': 'REVISION_ID',
'a': [
{
'line':
{
'n': 12,
'l': 3,
}
},
{
'line':
{
'n': 18,
'l': 1,
}
}]
}
Thay thế REVISION_ID bằng head hoặc mã nhận dạng của một bản sửa đổi cụ thể.
Giải quyết nhận xét
Sử dụng phương thức comment.update để đặt thuộc tính resolved trong tài nguyên comments thành true khi đã xử lý nhận xét.
Khi ứng dụng của bạn đặt thuộc tính resolved thành true, giao diện người dùng sẽ cho biết rằng nhận xét đã được xử lý. Ví dụ: ứng dụng của bạn có thể:
- Không cho phép trả lời thêm và làm mờ tất cả các câu trả lời trước đó cùng với nhận xét gốc.
- Ẩn các nhận xét đã giải quyết.
Xóa nhận xét
Sử dụng phương thức comments.delete để xoá bình luận. Khi một bình luận bị xoá, Drive sẽ đánh dấu tài nguyên bình luận đó là "deleted": "true".
Liệt kê bình luận
Sử dụng phương thức comments.list để liệt kê các nhận xét. Nếu bạn muốn đưa các bình luận đã xoá vào kết quả, hãy đặt trường includedDeleted thành true.