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

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