REST Resource: labels

{
  "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)
  }
}

string

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

string

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

string

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

enum (LabelType)

必須。ラベルのタイプ。

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

string

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

object (Properties)

必須。ラベルの基本的なプロパティです。

object (Lifecycle)

出力のみ。ラベルのライフサイクル状態（公開、サポート終了、下書きの変更の有無など）。

object (DisplayHints)

出力のみ。ラベルをレンダリングするための UI 表示のヒント。

object (AppliedCapabilities)

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

object (SchemaCapabilities)

出力のみ。ユーザーがこのラベルで使用できる機能。

object (AppliedLabelPolicy)

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

object (Field)

優先度の高いフィールドのリスト。

string

ユーザーにこのラベルと使い方の詳細を示すことができるカスタム URL です。

object (LockStatus)

出力のみ。このラベルの LockStatus。

{
  "person": string
}

string

詳細情報を取得するために People API で使用できるこのユーザーの ID。（例: People/12345678）。

{
  "title": string,
  "description": string
}

string

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

string

ラベルの説明。

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

出力のみ。このライフサイクルに関連付けられているオブジェクトの状態。

boolean

出力のみ。このライフサイクルに関連付けられているオブジェクトが公開されていないかどうかを示します。

object (DisabledPolicy)

無効になっているラベル、フィールド、選択内容を表示する方法を指定するポリシーです。

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

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

• false になると、オブジェクトは通常、無効として UI に表示されますが、ドライブのアイテムを検索すると検索結果に表示されます。
• true にすると、ドライブのアイテムを検索すると、通常はオブジェクトが UI に表示されなくなります。

boolean

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

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

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

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

boolean

ドライブのアイテムを検索する際、検索メニューにこのラベルは表示されません。

boolean

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

string (int64 format)

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

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

ユーザーがこのラベルに関連する適用されたメタデータを読み取ることができるかどうか。

boolean

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

boolean

ユーザーが項目からこのラベルを削除できるかどうか。

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

ドライブのアイテムをコピーする際に、適用されたラベルとフィールド値をどのようにコピーするかを示します。

{
  "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.
}

string

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

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

string

出力のみ。ファイルの検索クエリに対して定義されている値に基づいてファイルを検索する、ドライブの検索クエリの作成時に使用するキー。例: 「{queryKey} > 2001-01-01」。

object (Properties)

フィールドの基本的なプロパティです。

object (Lifecycle)

出力のみ。このフィールドのライフサイクル。

object (DisplayHints)

出力のみ。フィールドをレンダリングするための UI 表示のヒント。

object (SchemaCapabilities)

出力のみ。ユーザーがこのフィールドを編集したときに利用できる機能。

object (AppliedCapabilities)

出力のみ。ユーザーがこのフィールドで使用できる機能と、ドライブのアイテムにラベルを適用する場合の値。

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

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

object (UserInfo)

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

string (Timestamp format)

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

object (LockStatus)

出力のみ。このフィールドの LockStatus。

object (TextOptions)

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

object (IntegerOptions)

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

object (DateOptions)

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

object (SelectionOptions)

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

object (UserOptions)

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

{
  "minLength": integer,
  "maxLength": integer
}

integer

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

integer

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

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

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

string (int64 format)

出力のみ。整数フィールドの有効な最大値。

{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}

enum (DateFormat)

ローカライズされた日付形式オプション。フィールド値は、そのロケールに応じてこの形式でレンダリングされます。

string

出力のみ。ICU の日付形式。

object (Date)

出力のみ。有効な最小値（年、月、日）。

object (Date)

出力のみ。有効な最大値（年、月、日）。

{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}

object (ListOptions)

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

object (Choice)

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

{
  "maxEntries": integer
}

integer

入力できるエントリの最大数です。

{
  "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)
  }
}

string

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

object (Properties)

選択した基本プロパティ。

object (Lifecycle)

出力のみ。選択したライフサイクル。

object (DisplayHints)

出力のみ。選択肢をレンダリングするための UI 表示のヒント。

object (SchemaCapabilities)

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

object (AppliedCapabilities)

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

object (UserInfo)

出力のみ。この選択を作成したユーザー。

string (Timestamp format)

出力のみ。この選択が作成された時間。

object (UserInfo)

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

string (Timestamp format)

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

object (UserInfo)

出力のみ。この選択を公開したユーザー。選択内容が公開されていない場合、この値には意味がありません。

string (Timestamp format)

出力のみ。この選択が公開された時間。選択内容が公開されていない場合、この値には意味がありません。

object (UserInfo)

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

string (Timestamp format)

出力のみ。この選択が無効になっている時間。選択が無効になっている場合、この値は意味を持ちません。

object (LockStatus)

出力のみ。選択した LockStatus。

{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}

string

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

string

このラベルの説明です。

object (BadgeConfig)

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

string

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

{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}

object (Color)

バッジの色。指定しない場合、バッジはレンダリングされません。ここで設定した背景、フォアグラウンド、ソロ（ライトモード、ダークモード）の色は、サポートされている最も近い色にドライブの UI で変更されます。

string (int64 format)

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

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}

boolean

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

boolean

ドライブのアイテムを検索する場合は、このオプションを非表示にする必要があります。

boolean

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

object (BadgeColors)

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

object (BadgeColors)

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

string (int64 format)

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

{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}

object (Color)

出力のみ。前景とペア設定するバッジの背景。

object (Color)

出力のみ。背景にマッチするバッジのフォアグラウンド。

object (Color)

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

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

boolean

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

boolean

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

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

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

boolean

ユーザーがこのオプションを検索クエリで使用できるかどうか。

boolean

ユーザーが商品上でこの選択を選択できるかどうか。

{
  "locked": boolean
}

boolean

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

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

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

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

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

boolean

このフィールドを必須としてマークするかどうか。

string

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

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

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

boolean

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

boolean

ドライブのアイテムを検索する場合は、検索メニューにこのフィールドは表示されません。

boolean

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

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

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

boolean

ユーザーがこのフィールドを削除できるかどうか。ユーザーに権限が必要で、フィールドのサポートが終了している必要があります。

boolean

ユーザーがこのフィールドを無効にできるかどうか。ユーザーに権限が必要で、このフィールドがすでに無効にされていないことが必要です。

boolean

ユーザーがこのフィールドを有効にできるかどうかを指定します。ユーザーには権限が必要で、このフィールドは無効にする必要があります。

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

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

boolean

このフィールドを参照するドライブのアイテムをユーザーが検索できるかどうか。

boolean

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