ファイルのコメントを一覧表示します。
HTTP リクエスト
GET https://www.googleapis.com/drive/v3/files/{fileId}/comments
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
fileId |
ファイルの ID。 |
クエリ パラメータ
パラメータ | |
---|---|
includeDeleted |
削除されたコメントを含めるかどうか。削除されたコメントには、元のコンテンツは含まれません。 |
pageSize |
ページごとに返すコメントの最大数。 |
pageToken |
前のリスト リクエストを次のページに進めるためのトークン。この値は、前のレスポンスの「nextPageToken」の値に設定する必要があります。 |
startModifiedTime |
結果コメントの「modifiedTime」の最小値(RFC 3339 日時)。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
ファイルのコメントのリスト。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"kind": string,
"comments": [
{
object ( |
フィールド | |
---|---|
kind |
リソースの種類を示します。値: 固定文字列 |
comments[] |
コメントのリスト。nextPageToken が入力されている場合、このリストは不完全である可能性があるため、結果の追加ページを取得する必要があります。 |
nextPageToken |
コメントの次のページのページトークン。コメントリストの最後に到達した場合、この項目は表示されなくなります。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページネーションをやり直す必要があります。ページトークンは通常、数時間有効です。ただし、新しいアイテムを追加または削除すると、期待される結果が異なることがあります。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.readonly
一部のスコープは制限されているため、アプリで使用するにはセキュリティ評価が必要です。詳細については、承認ガイドをご覧ください。