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)
  }
}
フィールド
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。

LabelType

このラベルのタイプ。

列挙型
LABEL_TYPE_UNSPECIFIED 不明なラベルタイプです。
SHARED 共有ラベルは、ドライブのアイテムに適用するためにユーザーと共有できます。
ADMIN 管理者が所有するラベルです。管理者のみが作成および編集できます。管理者専用の追加機能をサポートします。

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 →（削除済み）

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

  • 公開済み - この状態のオブジェクトには、さまざまな種類の変更が行われることがあります。その場合、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

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

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 は透明色に相当します。これは、単純な浮動小数点スカラーではなくラッパー メッセージを使用します。これにより、デフォルト値が設定されたのか未設定値だったのかを区別できます。省略すると、このカラー オブジェクトはソリッド カラーとしてレンダリングされます（アルファ値を明示的に 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

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

メソッド

create

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

delete

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

delta

 一連の更新リクエストを適用して単一のラベルを更新します。その結果、新しい下書きリビジョンになります。

disable

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

enable

 無効になっているラベルを有効にして、公開済みの状態に復元します。

get

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

list

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

publish

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

updateLabelCopyMode

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

updatePermissions

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