REST Resource: labels

リソース: ラベル

ラベルは、ドライブのアイテムに適用してアイテムを整理、検索するための分類を定義します。ラベルは単純な文字列にすることも、ドライブのアイテムの整理や検索に使用できる追加のメタデータを記述するフィールドを含めることもできます。

JSON 表現 
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
フィールド
name

string

出力専用。ラベルのリソース名。リクエストに応じて、labels/{id} または labels/{id}@{revisionId} の形式になります。下記の id と revisionId をご覧ください。
id

string

出力専用。このラベルのグローバルに一意の識別子。ID はラベル name の一部を構成しますが、name とは異なり、ID はリビジョン間で一貫しています。正規表現 ([a-zA-Z0-9])+ と一致します。
revisionId

string

出力専用。ラベルのリビジョン ID。リビジョン ID は、発行されたリクエストによっては、ラベル name の一部になる場合があります。ラベルのリビジョン付きプロパティが変更されるたびに、新しいリビジョンが作成されます。正規表現 ([a-zA-Z0-9])+ と一致します。
labelType

enum (LabelType)

必須。ラベルのタイプ。
creator

object (UserInfo)

出力専用。このラベルを作成したユーザー。
createTime

string (Timestamp format)

出力専用。このラベルが作成された時刻。
revisionCreator

object (UserInfo)

出力専用。このラベルのリビジョンを作成したユーザー。
revisionCreateTime

string (Timestamp format)

出力専用。このラベル リビジョンが作成された時刻。
publisher

object (UserInfo)

出力専用。このラベルを公開したユーザー。ラベルが公開されていない場合、この値は意味を持ちません。
publishTime

string (Timestamp format)

出力専用。このラベルが公開された時刻。ラベルが公開されていない場合、この値は意味を持ちません。
disabler

object (UserInfo)

出力専用。このラベルを無効にしたユーザー。ラベルが無効になっていない場合、この値は意味を持ちません。
disableTime

string (Timestamp format)

出力専用。このラベルが無効にされた時刻。ラベルが無効になっていない場合、この値は意味を持ちません。
customer

string

出力専用。このラベルが属するお客様。例: 「customers/123abc789」。
properties

object (Properties)

必須。ラベルの基本プロパティ。
lifecycle

object (Lifecycle)

出力専用。ラベルのライフサイクルの状態（公開済みか、非推奨か、下書きの変更があるかなど）。
displayHints

object (DisplayHints)

出力専用。ラベルのレンダリングに関するヒントを UI に表示します。
appliedCapabilities

object (AppliedCapabilities)

出力専用。適用されたメタデータでこのラベルに関連する機能。
schemaCapabilities

object (SchemaCapabilities)

出力専用。このラベルに対するユーザーの権限。
appliedLabelPolicy

object (AppliedLabelPolicy)

出力専用。ドライブのアイテムに適用されたときのこのラベルの動作。
fields[]

object (Field)

フィールドのリスト（優先度の高い順）。
learnMoreUri

string

このラベルとその使用方法についてユーザーに詳しく説明するためのカスタム URL。
lockStatus

object (LockStatus)

出力専用。このラベルの LockStatus。
enabledAppSettings

object (EnabledAppSettings)

省略可。このラベルの EnabledAppSettings。

LabelType

このラベルのタイプ。

列挙型
LABEL_TYPE_UNSPECIFIED 不明なラベルタイプ。
SHARED 共有ラベルは、ユーザーと共有してドライブのアイテムに適用できます。
ADMIN 管理者が所有するラベル。作成と編集できるのは管理者のみが対象です。管理者専用の追加機能がサポートされている。
GOOGLE_APP お客様ではなく、Google の内部アプリケーションが所有するラベル。これらのラベルは読み取り専用です。

UserInfo

ユーザーに関する情報。

JSON 表現 
{
  "person": string
}
フィールド
person

string

このユーザーの ID。People API で使用して詳細情報を取得できます。例: people/12345678。

プロパティ

ラベルの基本プロパティ。

JSON 表現 
{
  "title": string,
  "description": string
}
フィールド
title

string

必須。ラベルのタイトル。
description

string

ラベルの説明。

Lifecycle

ラベル、フィールド、選択肢などのオブジェクトのライフサイクルの状態。ライフサイクルでは、次の遷移が強制されます。

  • UNPUBLISHED_DRAFT（開始状態）
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT ->（削除済み）
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED ->（削除済み）

公開状態と無効状態には、次のような違いがあります。

  • 公開済み - この状態のオブジェクトには、ある種の変更が加えられることがあります。その場合、hasUnpublishedChanges は true になります。また、一部の変更は許可されません。通常、ラベルに関連する既存のメタデータを無効にしたり、新しい制限を適用したりする変更は拒否されます。
  • 無効 - 無効にすると、構成された DisabledPolicy が有効になります。
JSON 表現 
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
フィールド
state

enum (State)

出力専用。このライフサイクルに関連付けられたオブジェクトの状態。
hasUnpublishedChanges

boolean

出力専用。このライフサイクルに関連付けられているオブジェクトに公開されていない変更があるかどうか。
disabledPolicy

object (DisabledPolicy)

無効なラベル、フィールド、選択肢の表示方法を管理するポリシー。

州

このライフサイクルに関連付けられたオブジェクトの状態。

列挙型
STATE_UNSPECIFIED 不明な状態。
UNPUBLISHED_DRAFT オブジェクトの初期状態。公開したオブジェクトをこの状態に戻すことはできません。オブジェクトを公開すると、特定の変更は許可されなくなります。
PUBLISHED オブジェクトが公開されました。オブジェクトに、hasUnpublishedChanges で示される未公開の下書きの変更が含まれている可能性があります。
DISABLED オブジェクトは公開された後、無効になっています。オブジェクトに、hasUnpublishedChanges で示される未公開の下書きの変更が含まれている可能性があります。
DELETED オブジェクトは削除されました。

DisabledPolicy

さまざまなコンテキストで無効なラベル、フィールド、選択肢を処理する方法を管理するポリシー。

JSON 表現 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
フィールド
showInApply

boolean

ドライブのアイテムの適用メニューに、この無効なオブジェクトを表示するかどうか。

  • true の場合、通常、オブジェクトは UI で無効として表示され、選択できません。
  • false の場合、通常、オブジェクトは UI に表示されません。

DisplayHints

ラベルのレンダリングに関するヒントを UI に表示します。

JSON 表現 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
フィールド
disabled

boolean

ラベルを UI で無効として表示するかどうか。
shownInApply

boolean

このラベルは、ドライブのアイテムに値を適用するときに適用メニューに表示されます。
priority

string (int64 format)

リストにラベルを表示する順序。

AppliedCapabilities

このラベルに適用されているメタデータに対するユーザーの権限。

JSON 表現 
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
フィールド
canRead

boolean

このラベルに関連付けられた適用済みメタデータをユーザーが読み取れるかどうか。
canApply

boolean

ユーザーがアイテムにこのラベルを適用できるかどうか。
canRemove

boolean

ユーザーがアイテムからこのラベルを削除できるかどうか。

SchemaCapabilities

ラベルを編集する際に、このラベルに関連する機能が表示されます。

JSON 表現 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
フィールド
canUpdate

boolean

ユーザーがこのラベルを変更できるかどうか。
canDelete

boolean

ユーザーがこのラベルを削除できるかどうか。ユーザーに権限があり、ラベルが無効になっている必要があります。
canDisable

boolean

ユーザーがこのラベルを無効にできるかどうか。ユーザーに権限があり、このラベルがすでに無効になっていないこと。
canEnable

boolean

ユーザーがこのラベルを有効にできるかどうか。ユーザーに権限があり、このラベルが無効になっている必要があります。

AppliedLabelPolicy

ドライブのアイテムに適用されたときのこのラベルの動作。

JSON 表現 
{
  "copyMode": enum (CopyMode)
}
フィールド
copyMode

enum (CopyMode)

ドライブのアイテムをコピーするときに、適用されたラベルとフィールド値をコピーする方法を示します。

CopyMode

ドライブのアイテムをコピーするときに、適用されたラベルとフィールド値をコピーする方法を示します。

列挙型
COPY_MODE_UNSPECIFIED コピーモードが指定されていません。
DO_NOT_COPY 適用されているラベルとフィールド値は、適用先の Google ドライブ アイテムがコピーされたときに、デフォルトではコピーされません。
ALWAYS_COPY 適用されたラベルとフィールド値は、適用先のドライブ アイテムがコピーされるときに常にコピーされます。このモードを使用できるのは管理者のみです。
COPY_APPLIABLE コピーを実行するユーザーがラベルを適用できる場合、適用されたラベルとフィールド値がコピーされます。

フィールド

表示名、データ型、その他の構成オプションを持つフィールドを定義します。このフィールドには、ドライブのアイテムに設定できるメタデータの種類を定義します。

JSON 表現 
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
フィールド
id

string

出力専用。ラベルまたはライブラリ内で一意のフィールドのキー。

この値は自動生成されます。正規表現 ([a-zA-Z0-9])+ と一致します。
queryKey

string

出力専用。ドライブの検索クエリを作成するときに使用するキー。ファイルのこのフィールドに定義された値に基づいてファイルを検索します。例: 「{queryKey} > 2001-01-01」。
properties

object (Properties)

フィールドの基本プロパティ。
lifecycle

object (Lifecycle)

出力専用。このフィールドのライフサイクル。
displayHints

object (DisplayHints)

出力専用。フィールドのレンダリングに関する UI 表示ヒント。
schemaCapabilities

object (SchemaCapabilities)

出力専用。このユーザーがこのフィールドを編集する際に利用できる機能。
appliedCapabilities

object (AppliedCapabilities)

出力専用。このユーザーがこのフィールドに対して持つ権限と、ドライブのアイテムにラベルが適用されたときの値。
creator

object (UserInfo)

出力専用。このフィールドを作成したユーザー。
createTime

string (Timestamp format)

出力専用。このフィールドが作成された時刻。
updater

object (UserInfo)

出力専用。このフィールドを変更したユーザー。
updateTime

string (Timestamp format)

出力専用。このフィールドが更新された時刻。
publisher

object (UserInfo)

出力専用。このフィールドを公開したユーザー。フィールドが公開されていない場合、この値は意味を持ちません。
disabler

object (UserInfo)

出力専用。このフィールドを無効にしたユーザー。フィールドが無効になっていない場合、この値は意味を持ちません。
disableTime

string (Timestamp format)

出力専用。このフィールドが無効にされた時刻。フィールドが無効になっていない場合、この値は意味を持ちません。
lockStatus

object (LockStatus)

出力専用。このフィールドの LockStatus。
共用体フィールド type。このフィールドのデータ型とオプション。公開したデータ型は変更できません。type は次のいずれかになります。
textOptions

object (TextOptions)

テキスト フィールドのオプション。
integerOptions

object (IntegerOptions)

整数フィールドのオプション。
dateOptions

object (DateOptions)

日付フィールドのオプション。
selectionOptions

object (SelectionOptions)

選択フィールドのオプション。
userOptions

object (UserOptions)

ユーザー フィールドのオプション。

TextOptions

Text フィールドタイプのオプション。

JSON 表現 
{
  "minLength": integer,
  "maxLength": integer
}
フィールド
minLength

integer

出力専用。テキスト フィールドの値の最小有効長。
maxLength

integer

出力専用。テキスト フィールドの値の有効な最大長。

IntegerOptions

整数フィールド型のオプション。

JSON 表現 
{
  "minValue": string,
  "maxValue": string
}
フィールド
minValue

string (int64 format)

出力専用。整数フィールドの有効な最小値。
maxValue

string (int64 format)

出力専用。整数フィールドで有効な最大値。

DateOptions

日付フィールドの種類のオプション。

JSON 表現 
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
フィールド
dateFormatType

enum (DateFormat)

ローカライズされた日付の書式設定オプション。フィールド値は、言語 / 地域に応じてこの形式でレンダリングされます。
dateFormat

string

出力専用。ICU の日付形式。
minValue

object (Date)

出力専用。有効な最小値（年、月、日）。
maxValue

object (Date)

出力専用。最大有効値（年、月、日）。

DateFormat

ローカライズされた日付形式のオプション。

列挙型
DATE_FORMAT_UNSPECIFIED 日付形式が指定されていません。
LONG_DATE 月の名前が含まれます。例: 1999 年 1 月 12 日（MMMM d, y）
SHORT_DATE 短い数値表現。例: 12/13/99（月/日/年）

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。これは次のいずれかを表します。

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に、年のみか年と月を指定するには 0 にする必要があります。

SelectionOptions

選択フィールドの種類のオプション。

JSON 表現 
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
フィールド
listOptions

object (ListOptions)

指定すると、このフィールドが値のリストをサポートしていることを示します。フィールドを公開した後は変更できません。
choices[]

object (Choice)

この選択フィールドで使用できるオプション。リストの順序は一貫しており、insertBeforeChoice で変更されています。

ListOptions

関連付けられているフィールドタイプの複数値バリアントのオプション。

JSON 表現 
{
  "maxEntries": integer
}
フィールド
maxEntries

integer

許可されるエントリの最大数。

選択肢

選択フィールドの選択。

JSON 表現 
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
フィールド
id

string

選択肢の一意の値。この ID は自動生成されます。正規表現 ([a-zA-Z0-9_])+ と一致します。
properties

object (Properties)

選択肢の基本プロパティ。
lifecycle

object (Lifecycle)

出力専用。選択肢のライフサイクル。
displayHints

object (DisplayHints)

出力専用。選択肢のレンダリングに関するヒントを示す UI ディスプレイ。
schemaCapabilities

object (SchemaCapabilities)

出力専用。オプションを編集する際に、このオプションに関連する機能。
appliedCapabilities

object (AppliedCapabilities)

出力専用。適用されたメタデータに関するこの選択に関連する機能。
creator

object (UserInfo)

出力専用。この選択を作成したユーザー。
createTime

string (Timestamp format)

出力専用。この選択が作成された時刻。
updater

object (UserInfo)

出力専用。この選択を最後に更新したユーザー。
updateTime

string (Timestamp format)

出力専用。この選択が最後に更新された時刻。
publisher

object (UserInfo)

出力専用。この選択を公開したユーザー。選択肢が公開されていない場合、この値は意味を持ちません。
publishTime

string (Timestamp format)

出力専用。この選択肢が公開された時刻。選択肢が公開されていない場合、この値は意味を持ちません。
disabler

object (UserInfo)

出力専用。この選択を無効にしたユーザー。この値は、オプションが無効になっていない場合に意味がありません。
disableTime

string (Timestamp format)

出力専用。この選択が無効にされた時刻。選択肢が無効になっていない場合、この値は意味を持ちません。
lockStatus

object (LockStatus)

出力専用。この選択肢の LockStatus。

プロパティ

選択肢の基本プロパティ。

JSON 表現 
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
フィールド
displayName

string

必須。このフィールドを識別する UI に表示する表示テキスト。
description

string

このラベルの説明。
badgeConfig

object (BadgeConfig)

この選択肢のバッチ設定。設定すると、この選択肢を所有するラベルは「バッジ付きラベル」と見なされます。
insertBeforeChoice

string

入力のみのこの選択肢を、指定された選択肢の前に挿入するか、移動します。空の場合、選択肢はリストの最後に配置されます。

BadgeConfig

ラベルのバッジのステータス。

JSON 表現 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
フィールド
color

object (Color)

バッジの色。指定しない場合、バッジはレンダリングされません。ここで設定した背景色、前景色、ソロ（ライトモードとダークモード）の色は、Google ドライブの UI で、推奨されるサポートされている色に近づけられます。
priorityOverride

string (int64 format)

このバッジのデフォルトのグローバル優先度をオーバーライドします。0 に設定すると、デフォルトの優先度ヒューリスティクスが使用されます。

色

RGBA カラースペースのカラーを表します。この表現は、コンパクトさよりも、さまざまな言語での色表現との間で簡単に変換できるように設計されています。たとえば、この表現のフィールドは、Java の java.awt.Color のコンストラクタに簡単に渡すことができます。また、iOS の UIColor の +colorWithRed:green:blue:alpha メソッドにも簡単に渡すことができます。また、少し手間をかければ、JavaScript で CSS rgba() 文字列に簡単にフォーマットできます。

このリファレンス ページには、RGB 値の解釈に使用する必要がある絶対色空間（sRGB、Adobe RGB、DCI-P3、BT.2020 など）に関する情報は含まれていません。デフォルトでは、アプリケーションは sRGB 色空間を想定します。

色の等価性を判断する必要がある場合、実装では、特に明記されていない限り、赤、緑、青、アルファの値がすべて最大 1e-5 の差異しかない場合、2 つの色を等価と見なします。

例（Java）:

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

例（iOS / Obj-C）:

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

例（JavaScript）:

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
JSON 表現 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
フィールド
red

number

カラーの赤色の量。[0, 1] の範囲内の値として示されます。
green

number

カラーの緑色の量。[0, 1] の範囲内の値として示されます。
blue

number

カラーの青色の量。[0, 1] の範囲内の値として示されます。
alpha

number

ピクセルに適用する必要があるこのカラーの割合。つまり、最終ピクセルカラーは以下の式によって定義されます。

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

つまり、値 1.0 はソリッドカラーに相当し、値 0.0 は透明色に相当します。これは、単純な浮動小数点スカラーではなくラッパー メッセージを使用します。これにより、デフォルト値が設定されたのか未設定値だったのかを区別できます。省略された場合、このカラー オブジェクトは（alpha 値として明示的に値 1.0 が指定された場合と同様に）ソリッドカラーとしてレンダリングされます。

DisplayHints

オプションのレンダリングに関する UI 表示ヒント。

JSON 表現 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
フィールド
disabled

boolean

オプションを UI で無効として表示するかどうか。
shownInApply

boolean

このオプションは、値をドライブのアイテムに適用するときに適用メニューに表示されます。
badgeColors

object (BadgeColors)

バッジに使用する色。選択した properties.badge_config.color に基づいて Google マテリアルの色に変更しました。
darkBadgeColors

object (BadgeColors)

バッジに使用するダークモードの色。選択した properties.badge_config.color に基づいて Google マテリアルの色に変更しました。
badgePriority

string (int64 format)

このバッジの優先度。複数のバッジを比較して並べ替えるために使用します。値が小さいほど、バッジが先に表示されます。バッジ設定が存在しない場合、この値は 0 になります。それ以外の場合は、BadgeConfig.priority_override または、ラベルの作成日、フィールドとオプションの優先度を優先するデフォルトのヒューリスティクスに設定されます。

BadgeColors

BadgeConfig から取得された色で、推奨されるサポートされている色に最も近い色に変更されています。

JSON 表現 
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
フィールド
backgroundColor

object (Color)

出力専用。フォアグラウンドとペアになるバッジの背景。
foregroundColor

object (Color)

出力専用。背景とペアになるバッジのフォアグラウンド。
soloColor

object (Color)

出力専用。背景のないテキストに使用できる色。

SchemaCapabilities

選択肢を編集する際に、この選択肢に関連する機能。

JSON 表現 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
フィールド
canUpdate

boolean

ユーザーがこの選択を更新できるかどうか。
canDelete

boolean

ユーザーがこの選択を削除できるかどうか。
canDisable

boolean

ユーザーがこの選択を無効にできるかどうか。
canEnable

boolean

ユーザーがこの選択を有効にできるかどうか。

AppliedCapabilities

適用されたメタデータに関するこの選択に関連する機能。

JSON 表現 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
フィールド
canRead

boolean

ユーザーがアイテムに適用された関連メタデータを読み取れるかどうか。
canSelect

boolean

ユーザーがアイテムでこの選択肢を選択できるかどうか。

LockStatus

ラベル コンポーネントをロック済みと見なすべきかどうかに関する情報が含まれます。

JSON 表現 
{
  "locked": boolean
}
フィールド
locked

boolean

出力専用。このラベル コンポーネントが LabelLock の（直接）ターゲットであるかどうかを示します。ラベル コンポーネントは、LabelLock の直接的なターゲットではない場合でも暗黙的にロックできます。その場合、このフィールドは false に設定されます。

UserOptions

ユーザー フィールドの種類のオプション。

JSON 表現 
{
  "listOptions": {
    object (ListOptions)
  }
}
フィールド
listOptions

object (ListOptions)

指定すると、このフィールドが値のリストをサポートしていることを示します。フィールドを公開した後は変更できません。

プロパティ

フィールドの基本プロパティ。

JSON 表現 
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
フィールド
displayName

string

必須。このフィールドを識別する UI に表示する表示テキスト。
required

boolean

フィールドを必須に設定するかどうか。
insertBeforeField

string

入力のみのこのフィールドを、指定されたフィールドの前に挿入するか、移動します。空の場合、フィールドはリストの末尾に配置されます。

DisplayHints

フィールドのレンダリングに関する UI 表示ヒント。

JSON 表現 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
フィールド
required

boolean

フィールドを UI で必須として表示するかどうか。
disabled

boolean

フィールドを UI で無効として表示するかどうか。
shownInApply

boolean

このフィールドは、値をドライブ アイテムに適用するときに適用メニューに表示されます。

SchemaCapabilities

フィールドを編集する際に、このフィールドに関連する機能。

JSON 表現 
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
フィールド
canUpdate

boolean

ユーザーがこのフィールドを変更できるかどうか。
canDelete

boolean

ユーザーがこのフィールドを削除できるかどうか。ユーザーに権限があり、フィールドが非推奨である必要があります。
canDisable

boolean

ユーザーがこのフィールドを無効にできるかどうか。ユーザーに権限があり、このフィールドがすでに無効になっていないこと。
canEnable

boolean

ユーザーがこのフィールドを有効にできるかどうか。ユーザーに権限があり、このフィールドが無効になっている必要があります。

AppliedCapabilities

適用されたメタデータのこのフィールドに関連する機能。

JSON 表現 
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
フィールド
canRead

boolean

ユーザーがアイテムに適用された関連メタデータを読み取れるかどうか。
canWrite

boolean

ユーザーがドライブのアイテムでこのフィールドを設定できるかどうか。

EnabledAppSettings

ラベルを使用できる Workspace アプリについて説明します。

JSON 表現 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
フィールド
enabledApps[]

object (EnabledApp)

省略可。ラベルを使用できるアプリのリスト。

EnabledApp

ラベルを使用できるアプリ。

JSON 表現 
{
  "app": enum (App)
}
フィールド
app

enum (App)

省略可。アプリの名前。

アプリ

ラベルを使用できる Workspace アプリのセット。

列挙型
APP_UNSPECIFIED 指定なし
DRIVE ドライブの移行と整理が課題になります
GMAIL Gmail

メソッド

create

 新しいラベルを作成します。

delete

 ドライブ アイテムのラベルと関連メタデータを完全に削除します。

delta

 一連の更新リクエストを適用して単一のラベルを更新し、新しいドラフト リビジョンを作成します。

disable

 公開済みのラベルを無効にする。

enable

 無効になっているラベルを有効にして、公開状態に戻します。

get

 リソース名でラベルを取得します。

list

 ラベルを一覧表示します。

publish

 ラベルの下書きの変更をすべて公開します。

updateLabelCopyMode

 ラベルの CopyMode を更新します。

updateLabelEnabledAppSettings

 ラベルの EabledAppSettings を更新します。

updatePermissions

 ラベルの権限を更新します。