Method: comments.list

ファイルのコメントを一覧表示します。

HTTP リクエスト

GET https://www.googleapis.com/drive/v2/files/{fileId}/comments

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
fileId

string

ファイルの ID。

クエリ パラメータ

パラメータ
includeDeleted

boolean

設定すると、削除されたコメントと返信(コンテンツが取り除かれた返信)を含むすべてのコメントと返信が返されます。

maxResults

integer

レスポンスに含めるディスカッションの最大数。ページングに使用されます。

pageToken

string

大量の結果セットのページ割り付けに使用する、継続トークンです。結果の次のページを取得するには、このパラメータを前のレスポンスの「nextPageToken」の値に設定します。

updatedMin

string

このタイムスタンプ以降に更新されたディスカッションのみが返されます。RFC 3339 タイムスタンプの形式。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Google ドライブ内のファイルに対するコメントのリスト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "items": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
フィールド
kind

string

これは常に drive#commentList です。

items[]

object (Comment)

コメントのリスト。nextPageToken が入力されている場合、このリストは不完全である可能性があるため、結果の追加ページを取得する必要があります。

nextPageToken

string

コメントの次のページのページトークン。コメントリストの最後に到達した場合、この項目は表示されなくなります。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページネーションをやり直す必要があります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.readonly

一部のスコープは制限されているため、アプリで使用するにはセキュリティ評価が必要です。詳細については、承認ガイドをご覧ください。