管理留言和回覆

Stay organized with collections Save and categorize content based on your preferences.

「註解」是由使用者提供的檔案意見回饋,例如用於處理句子重新句子的文書處理文件的讀取者。留言有 2 種類型:錨定註解無錨定註解。錨定註解在文件的特定版本中,與特定地點有關,例如用字處理文件中的句子。反之,未固定註解則只會與文件相關聯。

回覆會附加在留言中,代表使用者對留言的回覆。Google Drive API 可讓使用者針對應用程式建立的文件,新增註解及回覆內容。統整有回覆的留言稱為「討論」

新增未錨定註解

如要在文件中新增未錨定註解,請使用 fileId 參數呼叫 comments.create,並加上包含註解的 comments 資源。

註解是以純文字格式插入,但回應主體提供內含可顯示內容的 htmlContent 欄位。

在留言中新增回覆

如要在註解中新增回覆,請使用 replies.create 呼叫註解、fileId 參數以及包含回覆的 reply 資源。

系統會將回覆內容以純文字格式插入,但回應主體會提供內含可顯示內容的 htmlContent 欄位。

在文件的最新修訂版本中新增錨定註解

新增註解時,您可能會想要將檔案置於檔案內的某個區域。「錨點」會定義在註解中參照的檔案修訂版本和地區。comments 資源將 anchor 欄位定義為 JSON 字串。

如何新增錨定註解:

  1. (選用) 呼叫 revisions.list 列出文件的每個 revisionID。只有在您想將註解固定到最新修訂版本以外的任何修訂版本時,才需要執行這個步驟。如要使用最新的修訂版本,請在 revisionID 中使用 head

  2. 使用 fileID 參數呼叫 comments.create、包含註解的 comments 資源,以及包含 revisionID (r) 和地區 (a) 的 JSON 錨點字串。

定義區域的方式取決於您使用的文件內容類型。詳情請參閱下方的定義地區一節。

定義區域

如前文所述,JSON 錨定字串包含 revisionID (r) 和地區 (a)。區域 (a) 是一個 JSON 陣列,包含指定註解錨定格式的格式與位置。分類器可能是圖片的二維矩形、文件中的文字行、影片的時間長度等。如要定義地區,請選取與目標錨定內容類型相符的地區分類器。例如,如果您的內容是文字,則可能會使用 txtline 區域分類器。

如需 Drive API 中的區域分類器清單,請參閱地區分類器

以下範例顯示 JSON 錨點字串,用於將註解錨定在文件 2 個不同區域的線條:

  • 第一個區域從第 12 行 ('n':12) 開始,延伸 3 行 ('l':3)。
  • 第二個區域僅涵蓋第 18 行 ('n':18, 'l':1`)。
    {
      'r': revisionId`,
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

解決註解

註解處理後,請使用 comment.update 方法,將 comments 資源中的 resolved 屬性設為 true

當應用程式將 resolved 屬性設定為 true 時,UI 應指出註解已解決。舉例來說,您的應用程式可能會:

  • 不允許進一步回覆,並調暗所有先前回覆和原始留言。
  • 隱藏已解決的註解。

刪除留言

使用 comments.delete 方法刪除註解。註解刪除後,雲端硬碟會將註解資源標示為 "deleted": "true"

列出註解

使用 comments.list 方法列出註解。如果您想在結果中包含已刪除的註解,請將 includedDeleted 欄位設定為 true