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

詳細については、承認ガイドをご覧ください。