「註解」是使用者針對檔案提供的意見回饋,例如字詞處理文件的讀者建議如何改寫句子。註解有兩種類型:錨定註解和非錨定註解。錨定註解與特定位置相關聯,例如特定版本文件中的句子。相反地,未錨定註解只會與文件建立關聯。
回覆中附加在留言中,代表使用者對留言的回應。Google Drive API 可讓使用者針對應用程式建立的文件新增註解和回覆。附有回覆的註解統稱為「討論」。
新增未錨定註解
如要在文件中新增未錨定註解,請使用 fileId
參數呼叫 comments.create
方法,以及包含註解的 comments
資源。
註解會以純文字格式插入,但回應主體會提供 htmlContent
欄位,其中包含已設定顯示的內容。
回覆註解
如要在註解中新增回覆,請使用註解、fileId
參數以及包含回覆的 reply
資源呼叫 replies.create
方法。
回覆會以純文字格式插入,但回應主體會提供 htmlContent
欄位,其中包含可供顯示的內容格式。
在文件的最新修訂版本中新增錨定註解
新增註解時,您可能想將註解固定在檔案中的某個區域。「錨點」定義註解參照檔案內的檔案修訂版本和地區。comments
資源將 anchor
欄位定義為 JSON 字串。
如何新增錨定註解:
(選用) 呼叫
revisions.list
方法,列出文件的每個revisionID
。只有在您要將註解固定於最新版本以外的任何修訂版本時,才需要執行這個步驟。如果要使用最新的修訂版本,請針對revisionID
使用head
。呼叫
comments.create
方法:使用fileID
參數、包含註解的comments
資源,以及包含revisionID
(r
) 和區域 (a
) 的 JSON 錨定字串。
定義區域的方式取決於您處理的文件內容類型。詳情請參閱下方的「定義區域」一節。
定義區域
如前文所述,JSON 錨定字串包含 revisionID
(r
) 和區域 (a
)。區域 (a
) 是包含區域分類器的 JSON 陣列,用於指定註解錨定的格式和位置。分類器可以是 2D 矩形圖片、文件中一行文字、影片中的時間長度等。如要定義區域,請根據您嘗試錨定的內容類型選取相應的區域分類器。舉例來說,如果內容是文字,您可能會使用 txt
或 line
區域分類器。
如需 Drive API 的區域分類器清單,請參閱區域分類器。
以下範例顯示 JSON 錨定字串,可將註解固定在文件的 2 個不同區域:
- 第一個區域從第 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
時,UI 應指出該註解已解決。舉例來說,您的應用程式可能會:
- 不允許進一步回覆,並將先前的所有回覆加上原始註解。
- 隱藏已解決的註解。
刪除留言
您可以使用 comments.delete
方法刪除註解。註解遭到刪除時,雲端硬碟會將註解資源標示為 "deleted": "true"
。
清單註解
使用 comments.list
方法列出註解。如要在結果中包含已刪除的註解,請將 includedDeleted
欄位設為 true
。