댓글 및 답글 관리

댓글은 사용자가 파일에 제공하는 의견입니다. 예를 들어 워드프로세서 문서를 읽는 사용자가 문장 표현을 바꾸는 방법을 제안하는 경우를 들 수 있습니다. 주석에는 앵커링된 주석과 앵커링되지 않은 주석의 두 가지 유형이 있습니다. 고정된 주석은 특정 버전의 문서 내에서 특정 위치(예: 워드프로세서 문서의 문장)와 연결됩니다. 반대로 고정되지 않은 댓글은 문서와 연결되어 있을 뿐입니다.

참고: blob 파일에서 Google Drive API는 고정되지 않은 주석만 지원합니다. blob 파일 또는 Google Docs 편집기 파일의 고정 댓글은 지원되지 않습니다.

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

고정되지 않은 댓글 추가

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

댓글은 일반 텍스트로 삽입되지만 응답 본문에는 표시할 수 있도록 형식이 지정된 콘텐츠가 포함된 htmlContent 필드가 제공됩니다.

중요: 사용자에게 댓글을 추가할 수 있는 올바른 권한이 있는지 확인하는 것이 좋습니다. 또한 댓글이나 답글을 작성한 크리에이터만 댓글이나 답글을 삭제하거나 수정할 수 있습니다. 크리에이터가 아닌 역할의 사용자가 댓글을 삭제하거나 수정하려고 하면 오류가 발생합니다. 이러한 오류를 방지하려면 댓글 리소스의 author.me 필드를 확인하여 요청하는 사용자가 댓글 작성자인지 확인한 다음 댓글과 관련된 권한을 확인합니다.

댓글에 답글 추가하기

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

답장은 일반 텍스트로 삽입되지만 응답 본문에는 표시할 형식의 콘텐츠가 포함된 htmlContent 필드가 제공됩니다.

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

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

참고: blob 파일에서 Drive API는 고정되지 않은 주석만 지원합니다. blob 파일 또는 Google Docs 편집기 파일의 고정 댓글은 지원되지 않습니다.

중요: 앵커는 변경할 수 없으며 문서 콘텐츠와의 상대적 위치는 수정사항 간에 보장할 수 없습니다. 이미지 파일이나 읽기 전용 문서와 같이 위치가 변경되지 않는 문서에서는 앵커를 사용하는 것이 좋습니다.

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

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

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

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

참고: 사용자에게 댓글을 추가할 수 있는 올바른 권한이 있는지 확인하는 것이 좋습니다. 또한 댓글이나 답글을 작성한 크리에이터만 댓글이나 답글을 삭제하거나 수정할 수 있습니다. 크리에이터가 아닌 역할의 사용자가 댓글을 삭제하거나 수정하려고 하면 오류가 발생합니다. 이러한 오류를 방지하려면 comments 리소스의 author.me 필드를 확인하세요.

지역 정의

앞서 언급한 대로 JSON 앵커 문자열에는 revisionID (r) 및 지역 (a)이 포함됩니다. 지역 (a)은 주석이 고정되는 형식과 위치를 지정하는 지역 분류자가 포함된 JSON 배열입니다. 분류기는 이미지의 2차원 직사각형, 문서의 텍스트 줄 또는 동영상의 시간 길이일 수 있습니다. 지역을 정의하려면 연결하려는 콘텐츠 유형과 일치하는 지역 분류 기준을 선택합니다. 예를 들어 콘텐츠가 텍스트인 경우 txt 또는 line 지역 분류기를 사용하게 됩니다.

Drive API의 지역 분류자 목록은 지역 분류자를 참고하세요.

다음 예는 문서의 두 개 별도 영역의 줄에 주석을 고정하는 JSON 앵커 문자열을 보여줍니다.

• 첫 번째 영역은 12번 줄 ('n':12)에서 시작하여 3줄('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로 바꿉니다.

중요: 앱에서 사용자가 문서의 여러 버전을 업데이트하고 공유할 수 있는 경우 이전 버전의 주석이 더 이상 고정된 위치에 적용되지 않을 수 있습니다. 따라서 UI에서 각 주석이 속한 버전을 명확하게 표시해야 합니다.

댓글 해결하기

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

앱이 resolved 속성을 true로 설정하면 UI에 댓글이 해결되었음을 나타내야 합니다. 예를 들어 앱이 다음과 같은 경우

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

댓글 삭제

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

댓글 나열

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