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.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

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