Method: labels.list

ラベルを一覧表示します。詳細については、ラベルを検索するをご覧ください。

HTTP リクエスト

GET https://drivelabels.googleapis.com/v2/labels

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

クエリ パラメータ

パラメータ
publishedOnly

boolean

公開済みのラベルのみを結果に含めるかどうか。

  • true の場合、現在公開されているラベルのリビジョンのみが返されます。無効なラベルも含まれます。返されたラベル リソース名は、公開されたリビジョン（labels/{id}/{revisionId}）を参照します。
  • false の場合、現在のラベル リビジョンが返されます。これは公開されていない可能性があります。返されたラベル リソース名が特定のリビジョン（labels/{id}）を参照していません。
customer

string

このリスト リクエストのスコープを設定する顧客。例: customers/abcd1234。設定しない場合、現在の顧客内のすべてのラベルが返されます。
languageCode

string

ローカライズされたフィールド ラベルの評価に使用する BCP-47 言語コード。指定しない場合は、デフォルトで構成された言語の値が使用されます。
pageSize

integer

ページごとに返すラベルの最大数。デフォルト: 50。 最大: 200。
pageToken

string

返すページのトークン。
view

enum (LabelView)

指定した場合、指定されたビューに属する特定のフィールドのみが返されます。

結合パラメータ access。

access は次のいずれかになります。
useAdminAccess

boolean

ユーザーの管理者認証情報を使用するには、true に設定します。これにより、顧客内のすべてのラベルが返されます。
minimumRole

enum (LabelRole)

返されたラベルに対してユーザーが持つ必要のあるアクセスレベルを指定します。ラベルに対してユーザーが持つ必要のある最小限のロール。デフォルトは READER です。

リクエストの本文

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

レスポンスの本文

ラベルを一覧表示するためのレスポンス。

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

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

object (Label)

ラベル、
nextPageToken

string

レスポンスの次のページのトークン。

認可スコープ

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

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

詳しくは、承認ガイドをご覧ください。