Method: comments.list

ファイルのコメントを一覧表示します。詳細については、コメントと返信を管理するをご覧ください。

必須: fields パラメータを設定する必要があります。必要なフィールドのみを返すには、特定のフィールドを返すをご覧ください。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
fileId

string

ファイルの ID。

クエリ パラメータ

パラメータ
includeDeleted

boolean

削除されたコメントを含めるかどうか。削除されたコメントには元のコンテンツは含まれません。
pageSize

integer

ページごとに返されるコメントの最大数。
pageToken

string

前のリスト リクエストを次のページで続行するためのトークン。これは、前のレスポンスの nextPageToken の値に設定する必要があります。
startModifiedTime

string

結果コメントの「modifiedTime」の最小値（RFC 3339 日時）。

リクエスト本文

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

レスポンスの本文

ファイルのコメントのリスト。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

string

リソースの種類を示します。値は固定文字列 "drive#commentList" です。
comments[]

object (Comment)

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

string

コメントの次のページのページトークン。コメントリストの最後まで到達した場合は、この項目は表示されません。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページネーションを再開する必要があります。通常、ページトークンは数時間有効です。ただし、新しいアイテムが追加または削除された場合は、想定される結果が異なる可能性があります。

認可スコープ

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

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

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