Method: files.listLabels

ファイルのラベルを一覧表示します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
fileId

string

ファイルの ID。

クエリ パラメータ

パラメータ
maxResults

integer

ページごとに返すラベルの最大数。設定しない場合、デフォルトで 100 になります。

pageToken

string

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

リクエスト本文

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

レスポンスの本文

ファイルに適用されるラベルのリスト。

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

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

object (Label)

ラベルのリスト。

nextPageToken

string

ラベルの次のページのページトークン。リストの最後に到達した場合、このフィールドは存在しません。なんらかの理由でトークンが拒否された場合は、トークンを破棄し、結果の最初のページからページネーションをやり直す必要があります。ページトークンは通常、数時間有効です。ただし、新しいアイテムを追加または削除すると、期待される結果が異なることがあります。

kind

string

常に drive#labelList です。

認可スコープ

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

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

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