REST Resource: labels

リソース: Label

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

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

このユーザーの識別子。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 ->（削除済み）

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

  • Published: この状態のオブジェクトに対して変更が行われることがあります。その場合、hasUnpublishedChanges は true になります。また、一部の種類の変更は許可されていません。一般に、ラベルに関連する既存のメタデータを無効にする変更や、新しい制限を課す変更は拒否されます。
  • Disabled: 無効にすると、構成された 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 ラベルとフィールドの値は、適用先のドライブ アイテムがコピーされても、デフォルトではコピーされません。
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

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

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（M/d/yy）

日付

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

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

関連するタイプ:

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)

バッジの色。指定しない場合、バッジはレンダリングされません。ここで設定した背景色、前景色、ソロ色（ライトモードとダークモード）は、ドライブの 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

出力専用。このラベル コンポーネントがラベルロックの（直接の）ターゲットであるかどうかを示します。ラベル コンポーネントは、ラベルロックの直接のターゲットでなくても暗黙的にロックされることがあります。この場合、このフィールドは 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

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

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

object (EnabledApp)

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

EnabledApp

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

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

enum (App)

省略可。アプリの名前。

アプリ

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

列挙型
APP_UNSPECIFIED 指定なし
DRIVE ドライブ
GMAIL Gmail

メソッド

create

 ラベルを作成します。

delete

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

delta

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

disable

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

enable

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

get

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

list

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

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

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

updatePermissions

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