コメントと返信を管理する

コメントとは、ファイルに対するユーザーが提供するフィードバックです。たとえば、ファイルの閲覧者などがコメントとして 文章の言い換え方を提案するワープロ文書。2 つのモデル コメントの種類: アンカーコメントアンカーなしコメント。アンカー型 コメントが特定の場所に関連付けられている場合(例: 特定のバージョンの文書に保持される文書です。逆に アンカーのないコメントは、ドキュメントにのみ関連付けられます。

返信はコメントに添付され、コメントに対するユーザーの返信を表します。 あります。Drive API を使用すると、ユーザーは Google ドライブにコメントや 作成することもできます。コメントに対する返信の総称は、 ディスカッションを行います。

固定されていないコメントを追加する

固定されていないコメントをドキュメントに追加するには、 comments.create メソッドを fileId パラメータと コメントを含む comments リソース。

コメントは書式なしテキストとして挿入されますが、レスポンスの本文には 表示用にフォーマットされたコンテンツを含む htmlContent フィールド。

コメントに返信を追加する

コメントに返信を追加するには、 replies.create メソッド fileId パラメータ、replies リソース 返されます。

返信は書式なしテキストとして挿入されますが、レスポンスの本文には 表示用にフォーマットされたコンテンツを含む htmlContent フィールド。

ドキュメントの最新の版に固定されたコメントを追加する

コメントを追加するときは、ファイル内の領域にコメントを固定することをおすすめします。「 anchor は、コメントを追加するファイルのリビジョンとファイル内の領域を定義します。 参照します。comments リソースは、 JSON 文字列としての anchor フィールド。

固定コメントを追加するには:

  1. (省略可)revisions.list を呼び出す メソッドを使用して、ドキュメントのすべての revisionID を一覧表示します。次の場合にのみ、この手順を実施してください。 最新の版以外の版にコメントを固定する。 最新のリビジョンを使用する場合は、revisionIDhead を使用します。

  2. comments.create メソッドを呼び出す fileID パラメータ(comments) コメントを含むリソースと、コメントを含む JSON アンカー文字列が revisionIDr)とリージョン(a)です。

地域を定義する方法は、作業するドキュメントのコンテンツの種類によって異なります できます。詳細については、リージョンを定義するをご覧ください。

リージョンを定義する

前述のように、JSON アンカー文字列には revisionIDr)と リージョン(a)。地域(a)は、地域分類器を含む JSON 配列です。 コメントをアンカーする形式と場所を指定します。分類器 画像の場合は 2 次元の長方形、ドキュメント内の 1 行、 動画の長さを指定しますリージョンを定義するには、リージョン 分類器を見つけます。対象 たとえば、コンテンツがテキストの場合、txt または line リージョン分類器を使用します。

Drive API で使用される地域分類の一覧については、地域分類をご覧ください。 分類器です

次の例は、コメントを行に固定する JSON アンカー文字列を示しています。 ドキュメントの 2 つの領域に分けて表示します。

  • 最初の領域は 12 行目('n':12)から始まり、3 行にわたって続きます。 ('l':3).
  • 2 つ目の領域は 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 メソッドを使用して以下を設定します。 commentsresolved プロパティ コメントに対処したら、true にリソースを追加します。

アプリで resolved プロパティを true に設定すると、UI に 解決したことを示します。たとえば、アプリは次のようになります。

  • それ以降の返信を禁止し、以前の返信と元の返信をすべて暗くします あります。
  • 解決済みのコメントを非表示にする。

コメントを削除する

comments.delete メソッドを使用して、以下を行います。 コメントを削除できます。コメントが削除されると、ドライブではコメントに "deleted": "true" としてのコメント リソース。

コメントの一覧表示

comments.list メソッドを使用して、リストを取得します。 できます。削除済みのコメントを結果に含める場合は、 includedDeleted フィールドを true に設定。