註解是使用者針對檔案提供的意見回饋,例如文字處理文件的讀者建議如何改寫句子。註解分為兩種類型:錨定註解和非錨定註解。錨定註解會與特定位置 (例如文字處理文件中的句子) 建立關聯,該位置位於文件的特定版本中。相反地,未錨定的註解只會與文件建立關聯。
回覆會附加至留言,代表使用者對留言的回應。Drive API 可讓使用者在應用程式建立的文件中新增註解和回覆。註解和回覆統稱為「討論」。
新增未錨定註解
如要在文件中加入未錨定的註解,請使用 fileId
參數和含有註解的 comments
資源,呼叫 comments.create
方法。
註解會以純文字插入,但回應主體會提供 htmlContent
欄位,其中包含格式化供顯示的內容。
在註解中新增回覆
如要為留言新增回覆,請使用留言、fileId
參數和包含回覆的 replies
資源,呼叫 replies.create
方法。
回覆會以純文字插入,但回應主體會提供 htmlContent
欄位,其中包含格式化供顯示的內容。
在文件的最新修訂版本中加入錨定註解
新增註解時,您可能會想將註解錨定至檔案中的某個區域。錨點可定義註解參照的檔案修訂版本和地區。comments
資源會將 anchor
欄位定義為 JSON 字串。
如要新增錨定註解,請按照下列步驟操作:
(選用) 呼叫
revisions.list
方法,即可列出文件的每個revisionID
。因此,如要將註解固定至最新修訂版本以外的任何修訂版本,才需要執行這個步驟。如要使用最新修訂版本,請為revisionID
使用head
。使用
fileID
參數、包含註解的comments
資源,以及包含revisionID
(r
) 和區域 (a
) 的 JSON 錨點字串,呼叫comments.create
方法。
定義區域的方式取決於您使用的文件內容類型。詳情請參閱「定義區域」。
定義區域
如先前所述,JSON 錨點字串包含 revisionID
(r
) 和區域 (a
)。區域 (a
) 是包含區域分類器的 JSON 陣列,可指定註解的格式和錨點位置。分類器可以是 2D 矩形圖片、文件中一行文字,或影片的時間長度。如要定義區域,請選取與要錨定的內容類型相符的區域分類器。舉例來說,如果您的內容是文字,您可能會使用 txt
或 line
區域分類器。
如需 Drive API 中的區域分類器清單,請參閱「區域分類器」。
以下範例是 JSON 錨定字串,將註解錨定在文件中兩個不同區域的行:
- 第一個區域從第 12 行 (
'n':12
) 開始,延伸至三行 ('l':3
)。 - 第二個區域只涵蓋第 18 行 (
'n':18, 'l':1
`)。
{
'r': 'REVISION_ID',
'a': [
{
'line':
{
'n': 12,
'l': 3,
}
},
{
'line':
{
'n': 18,
'l': 1,
}
}]
}
將 REVISION_ID 替換為 head
或特定修訂版本的 ID。
解決註解
使用 comment.update
方法將 comments
資源中的 resolved
屬性設為 true
時,表示已解決註解問題。
當應用程式將 resolved
屬性設為 true
時,使用者介面應會指出已處理該評論。舉例來說,應用程式可能會:
- 禁止進一步回覆,並將所有先前的回覆和原始留言調暗。
- 隱藏已解決的註解。
刪除留言
請使用 comments.delete
方法刪除留言。刪除註解時,雲端硬碟會將註解資源標示為 "deleted": "true"
。
可列出註解
請使用 comments.list
方法列出留言。如果您希望結果中包含已刪除的留言,請將 includedDeleted
欄位設為 true
。