댓글 및 답글 관리

주석은 파일에 관한 사용자 제공 피드백입니다. 예를 들어 문장을 다르게 작성하는 방법을 제안하는 워드 프로세서 문서의 리더가 될 수 있습니다. 주석에는 고정된 댓글고정되지 않은 댓글, 이렇게 두 가지 유형이 있습니다. 앵커 주석은 특정 버전의 문서 내에 있는 워드 프로세서 문서의 문장과 같은 특정 위치와 연결됩니다. 반대로 고정되지 않은 댓글은 문서에만 연결됩니다.

답글은 댓글에 첨부되며 댓글에 대한 사용자의 응답을 나타냅니다. Google Drive API를 사용하면 사용자가 앱에서 만든 문서에 댓글과 답글을 추가할 수 있습니다. 총칭하여 답글이 있는 댓글을 토론이라고 합니다.

고정되지 않은 댓글 추가

문서에 고정되지 않은 댓글을 추가하려면 fileId 매개변수와 댓글이 포함된 comments 리소스를 사용하여 comments.create 메서드를 호출합니다.

주석은 일반 텍스트로 삽입되지만 응답 본문은 표시용으로 형식이 지정된 콘텐츠가 포함된 htmlContent 필드를 제공합니다.

댓글에 답글 추가

댓글에 답글을 추가하려면 댓글, fileId 매개변수, 답글이 포함된 reply 리소스와 함께 replies.create 메서드를 호출합니다.

답장은 일반 텍스트로 삽입되지만 응답 본문은 표시용으로 형식이 지정된 콘텐츠가 포함된 htmlContent 필드를 제공합니다.

문서의 최신 버전에 고정된 댓글 추가하기

댓글을 추가할 때 파일의 영역에 고정할 수 있습니다. 앵커는 댓글이 참조하는 파일의 파일 버전 및 리전을 정의합니다. comments 리소스는 anchor 필드를 JSON 문자열로 정의합니다.

고정 댓글을 추가하려면 다음 단계를 따르세요.

  1. (선택사항) revisions.list 메서드를 호출하여 문서의 모든 revisionID를 나열합니다. 최신 버전이 아닌 버전에 주석을 고정하려는 경우에만 이 단계를 따르세요. 최신 버전을 사용하려면 revisionIDhead를 사용하세요.

  2. fileID 매개변수, 주석이 포함된 comments 리소스, revisionID (r) 및 지역 (a)이 포함된 JSON 앵커 문자열을 사용하여 comments.create 메서드를 호출합니다.

지역을 정의하는 방법은 작업 중인 문서 콘텐츠의 유형에 따라 다릅니다. 자세한 내용은 아래의 리전 정의를 참고하세요.

지역 정의

앞서 언급했듯이 JSON 앵커 문자열에는 revisionID (r) 및 리전 (a)이 포함됩니다. 리전 (a)은 댓글이 고정된 형식과 위치를 지정하는 리전 분류 기준이 포함된 JSON 배열입니다. 분류 기준은 이미지의 2차원 직사각형, 문서의 텍스트 행, 동영상의 길이 등일 수 있습니다. 지역을 정의하려면 고정하려는 콘텐츠 유형과 일치하는 지역 분류 기준을 선택합니다. 예를 들어 콘텐츠가 텍스트인 경우 txt 또는 line 지역 분류 기준을 사용할 가능성이 높습니다.

Drive API의 지역 분류 기준 목록은 지역 분류 기준을 참고하세요.

다음 예는 문서의 개별 2개 영역에 있는 줄에 주석을 고정하는 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_IDhead 또는 특정 버전의 ID로 바꿉니다.

댓글 해결

댓글을 처리한 경우 comment.update 메서드를 사용하여 comments 리소스의 resolved 속성을 true로 설정합니다.

앱에서 resolved 속성을 true로 설정하면 UI에서는 주석이 처리되었음을 나타내야 합니다. 예를 들어 앱은 다음과 같은 작업을 할 수 있습니다.

  • 추가 답장을 허용하지 않고 모든 이전 답장과 원래 댓글을 어둡게 합니다.
  • 해결된 댓글 숨기기

댓글 삭제

주석을 삭제하려면 comments.delete 메서드를 사용합니다. 댓글이 삭제되면 Drive에서 댓글 리소스를 "deleted": "true"로 표시합니다.

의견 나열

주석을 나열하려면 comments.list 메서드를 사용합니다. 삭제된 댓글을 결과에 포함하려면 includedDeleted 필드를 true로 설정합니다.