- リソース: Label
- LabelType
- UserInfo
- プロパティ
- ライフサイクル
- ステータス
- DisabledPolicy
- DisplayHints
- AppliedCapabilities
- SchemaCapabilities
- AppliedLabelPolicy
- CopyMode
- フィールド
- TextOptions
- IntegerOptions
- DateOptions
- DateFormat
- SelectionOptions
- ListOptions
- 選択肢
- プロパティ
- BadgeConfig
- DisplayHints
- BadgeColors
- SchemaCapabilities
- AppliedCapabilities
- LockStatus
- UserOptions
- プロパティ
- DisplayHints
- SchemaCapabilities
- AppliedCapabilities
- メソッド
リソース: ラベル
ラベルは、複数のアイテムを整理、検索するためにドライブのアイテムに適用できる分類を定義します。ラベルは単純な文字列にすることも、追加のメタデータを記述するフィールドを含めることもできます。このメタデータは、ドライブのアイテムの整理、検索に使用できます。
JSON 表現 |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
フィールド | |
---|---|
name |
出力のみ。ラベルのリソース名。リクエストに応じて、 |
id |
出力のみ。このラベルのグローバルに一意の識別子。ID はラベル |
revisionId |
出力のみ。ラベルのリビジョン ID。発行されたリクエストによっては、リビジョン ID がラベル |
labelType |
必須。ラベルのタイプ。 |
creator |
出力のみ。このラベルを作成したユーザー。 |
createTime |
出力のみ。このラベルが作成された時刻。 |
revisionCreator |
出力のみ。このラベル リビジョンを作成したユーザー。 |
revisionCreateTime |
出力のみ。このラベルのリビジョンが作成された時刻。 |
publisher |
出力のみ。このラベルを公開したユーザー。ラベルが公開されていない場合、この値は意味を持ちません。 |
publishTime |
出力のみ。このラベルが公開された時刻。ラベルが公開されていない場合、この値は意味を持ちません。 |
disabler |
出力のみ。このラベルを無効にしたユーザー。ラベルが無効でない場合、この値は意味を持ちません。 |
disableTime |
出力のみ。このラベルが無効になった時刻。ラベルが無効でない場合、この値は意味を持ちません。 |
customer |
出力のみ。このラベルが属する顧客。例: 「customers/123abc789」 |
properties |
必須。ラベルの基本プロパティ。 |
lifecycle |
出力のみ。ラベルのライフサイクルの状態(公開済み、サポート終了、下書きの変更の有無など)。 |
displayHints |
出力のみ。ラベルをレンダリングするための UI 表示ヒント。 |
appliedCapabilities |
出力のみ。適用されたメタデータでこのラベルに関連する機能。 |
schemaCapabilities |
出力のみ。このラベルに対してユーザーが持つ機能。 |
appliedLabelPolicy |
出力のみ。このラベルをドライブのアイテムに適用した場合の動作。 |
fields[] |
優先度の降順のフィールドのリスト。 |
learnMoreUri |
このラベルの詳細と使用方法をユーザーが確認できるように、ユーザーに表示するカスタム URL。 |
lockStatus |
出力のみ。このラベルの LockStatus。 |
LabelType
このラベルのタイプ。
列挙型 | |
---|---|
LABEL_TYPE_UNSPECIFIED |
不明なラベルタイプです。 |
SHARED |
ドライブのアイテムに適用する共有ラベルは、ユーザーと共有される場合があります。 |
ADMIN |
管理者所有のラベル。管理者のみが作成および編集できる。管理者専用の追加機能をいくつかサポートしています。 |
UserInfo
ユーザーに関する情報。
JSON 表現 |
---|
{ "person": string } |
フィールド | |
---|---|
person |
詳細情報を取得するために People API で使用できる、このユーザーの識別子。(例: people/12345678)。 |
プロパティ
ラベルの基本プロパティ。
JSON 表現 |
---|
{ "title": string, "description": string } |
フィールド | |
---|---|
title |
必須。ラベルのタイトル。 |
description |
ラベルの説明。 |
ライフサイクル
ラベル、フィールド、選択など、オブジェクトのライフサイクルの状態。このライフサイクルでは、次の移行が適用されます。
UNPUBLISHED_DRAFT
(開始状態)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
->(削除済み)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
->(削除済み)
公開状態と無効状態には、いくつかの異なる特徴があります。
- 公開済み - この状態では、オブジェクトになんらかの変更が行われる可能性があります。その場合、
hasUnpublishedChanges
は true になります。また、許可されない変更もあります。一般に、ラベルに関連する既存のメタデータを無効にする、または新しい制限を発生させるような変更は承認されません。 - 無効 - 無効にすると、設定済みの
DisabledPolicy
が有効になります。
JSON 表現 |
---|
{ "state": enum ( |
フィールド | |
---|---|
state |
出力のみ。このライフサイクルに関連付けられているオブジェクトの状態。 |
hasUnpublishedChanges |
出力のみ。このライフサイクルに関連付けられているオブジェクトに未公開の変更があるかどうか。 |
disabledPolicy |
無効になっているラベル、フィールド、選択項目の表示方法を管理するポリシー。 |
状態
このライフサイクルに関連付けられているオブジェクトの状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
不明なステータス。 |
UNPUBLISHED_DRAFT |
オブジェクトの初期状態。いったん公開すると、オブジェクトがこの状態に戻ることはありません。オブジェクトの公開後は、特定の種類の変更ができなくなります。 |
PUBLISHED |
オブジェクトを公開しました。オブジェクトには、hasUnpublishedChanges で示される未公開の変更の下書きが含まれている可能性があります。 |
DISABLED |
オブジェクトは公開され、無効になっています。オブジェクトには、hasUnpublishedChanges で示される未公開の変更の下書きが含まれている可能性があります。 |
DELETED |
オブジェクトが削除されました。 |
DisabledPolicy
無効になったラベル、フィールド、選択項目をさまざまな状況で扱う方法を管理するポリシー。
JSON 表現 |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
フィールド | |
---|---|
hideInSearch |
ドライブのアイテムの検索メニューで、この無効なオブジェクトを非表示にするかどうかを指定します。
|
showInApply |
ドライブのアイテムの適用メニューに、この無効なオブジェクトを表示するかどうかを指定します。
|
DisplayHints
ラベルをレンダリングするための UI 表示ヒント。
JSON 表現 |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
フィールド | |
---|---|
disabled |
ラベルを無効として UI に表示するかどうか。 |
shownInApply |
このラベルは、ドライブのアイテムに値を適用する際に [適用] メニューに表示されます。 |
priority |
リストでラベルを表示する順序。 |
AppliedCapabilities
このラベルの適用メタデータに対するユーザーの権限。
JSON 表現 |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
フィールド | |
---|---|
canRead |
このラベルに関連する適用済みのメタデータをユーザーが読み取れるかどうか。 |
canApply |
ユーザーがこのラベルをアイテムに適用できるかどうか。 |
canRemove |
ユーザーがアイテムからこのラベルを削除できるかどうか。 |
SchemaCapabilities
ラベル編集時にこのラベルに関連する機能。
JSON 表現 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
フィールド | |
---|---|
canUpdate |
ユーザーがこのラベルを変更できるかどうか。 |
canDelete |
ユーザーがこのラベルを削除できるかどうか。ユーザーには権限があり、ラベルが無効になっている必要があります。 |
canDisable |
ユーザーがこのラベルを無効にできるかどうか。ユーザーには権限が必要です。また、このラベルが無効になっている必要があります。 |
canEnable |
ユーザーがこのラベルを有効にできるかどうか。ユーザーには権限が必要で、このラベルを無効にする必要があります。 |
AppliedLabelPolicy
このラベルをドライブのアイテムに適用した場合の動作。
JSON 表現 |
---|
{
"copyMode": enum ( |
フィールド | |
---|---|
copyMode |
ドライブのアイテムをコピーする際に、適用したラベルとフィールドの値をコピーする方法について説明します。 |
CopyMode
ドライブのアイテムをコピーする際に、適用したラベルとフィールドの値をコピーする方法について説明します。
列挙型 | |
---|---|
COPY_MODE_UNSPECIFIED |
コピーモードが指定されていません。 |
DO_NOT_COPY |
デフォルトでは、適用したラベルとフィールドの値は、適用先のドライブのアイテムをコピーする際にコピーされません。 |
ALWAYS_COPY |
適用したラベルとフィールドの値は、適用先のドライブのアイテムがコピーされたときに常にコピーされます。このモードを使用できるのは管理者のみです。 |
COPY_APPLIABLE |
適用したラベルとフィールドの値は、コピーを作成するユーザーがラベルを適用できる場合にコピーされます。 |
項目
表示名、データ型、その他の構成オプションを持つフィールドを定義します。このフィールドでは、ドライブのアイテムに対して設定可能なメタデータの種類を定義します。
JSON 表現 |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
フィールド | |
---|---|
id |
出力のみ。フィールドのキー。ラベルまたはライブラリ内で一意です。 この値は自動生成されます。次の正規表現に一致します: |
queryKey |
出力のみ。ファイルのこのフィールドに定義された値に基づいてファイルを見つけるドライブの検索クエリを作成するときに使用するキー。例: " |
properties |
フィールドの基本プロパティ。 |
lifecycle |
出力のみ。このフィールドのライフサイクル。 |
displayHints |
出力のみ。フィールドをレンダリングするための UI 表示ヒント。 |
schemaCapabilities |
出力のみ。このフィールドを編集する際にこのユーザーが持つ権限。 |
appliedCapabilities |
出力のみ。ユーザーがこのフィールドで持つ権限と、ドライブのアイテムにラベルが適用されたときの値。 |
creator |
出力のみ。このフィールドを作成したユーザー。 |
createTime |
出力のみ。このフィールドが作成された時刻。 |
updater |
出力のみ。このフィールドを変更したユーザー。 |
updateTime |
出力のみ。このフィールドが更新された時刻。 |
publisher |
出力のみ。このフィールドを公開したユーザー。フィールドが公開されていない場合、この値は意味を持ちません。 |
disabler |
出力のみ。このフィールドを無効にしたユーザー。フィールドが無効になっていない場合、この値は意味を持ちません。 |
disableTime |
出力のみ。このフィールドが無効になった時刻。フィールドが無効になっていない場合、この値は意味を持ちません。 |
lockStatus |
出力のみ。このフィールドの LockStatus。 |
共用体フィールド type 。このフィールドのデータ型とオプション。公開すると、データ型は変更できません。type は次のいずれかになります。 |
|
textOptions |
テキスト フィールドのオプション。 |
integerOptions |
整数フィールドのオプション。 |
dateOptions |
日付フィールドのオプション。 |
selectionOptions |
選択フィールドのオプション。 |
userOptions |
ユーザー フィールドのオプション。 |
TextOptions
[テキスト] フィールド タイプのオプション。
JSON 表現 |
---|
{ "minLength": integer, "maxLength": integer } |
フィールド | |
---|---|
minLength |
出力のみ。テキスト フィールドの有効な値の最小長。 |
maxLength |
出力のみ。テキスト フィールドの値の有効な最大長。 |
IntegerOptions
整数フィールド タイプのオプション。
JSON 表現 |
---|
{ "minValue": string, "maxValue": string } |
フィールド | |
---|---|
minValue |
出力のみ。整数フィールドの有効な値の最小値。 |
maxValue |
出力のみ。整数フィールドの有効な値の最大数。 |
DateOptions
日付フィールド タイプのオプション。
JSON 表現 |
---|
{ "dateFormatType": enum ( |
フィールド | |
---|---|
dateFormatType |
ローカライズされた日付形式のオプション。フィールド値は、ロケールに応じて次の形式でレンダリングされます。 |
dateFormat |
出力のみ。ICU 日付形式。 |
minValue |
出力のみ。有効な値の最小値(年、月、日)。 |
maxValue |
出力のみ。有効な値の最大値(年、月、日)。 |
DateFormat
ローカライズされた日付形式のオプション。
列挙型 | |
---|---|
DATE_FORMAT_UNSPECIFIED |
日付形式が指定されていません。 |
LONG_DATE |
月の名前を含めます。例: 1999 年 1 月 12 日 (MMMM d, y) |
SHORT_DATE |
短い数値表現。例: 12/13/99 (M/d/yy) |
SelectionOptions
選択フィールド タイプのオプション。
JSON 表現 |
---|
{ "listOptions": { object ( |
フィールド | |
---|---|
listOptions |
指定すると、このフィールドが値のリストをサポートすることを示します。項目が公開されると、変更できなくなります。 |
choices[] |
この選択フィールドで使用できるオプション。リストの順序は一貫しており、 |
ListOptions
関連付けられたフィールド タイプの複数値を持つバリアントのオプション。
JSON 表現 |
---|
{ "maxEntries": integer } |
フィールド | |
---|---|
maxEntries |
指定できるエントリの最大数です。 |
選択肢
選択フィールドの選択。
JSON 表現 |
---|
{ "id": string, "properties": { object ( |
フィールド | |
---|---|
id |
選択した一意の値。この ID は自動生成されます。次の正規表現に一致します: |
properties |
選択した基本プロパティ。 |
lifecycle |
出力のみ。任意のライフサイクル。 |
displayHints |
出力のみ。選択肢をレンダリングするための UI 表示ヒント。 |
schemaCapabilities |
出力のみ。オプション編集時にこのオプションに関連する機能。 |
appliedCapabilities |
出力のみ。適用されるメタデータに対するこの選択に関連する機能。 |
creator |
出力のみ。この選択を作成したユーザー。 |
createTime |
出力のみ。この選択が作成された時刻。 |
updater |
出力のみ。この選択を最後に更新したユーザー。 |
updateTime |
出力のみ。この選択が最後に更新された時刻。 |
publisher |
出力のみ。この選択を公開したユーザー。選択肢が公開されていない場合、この値は意味を持ちません。 |
publishTime |
出力のみ。この選択が公開された時刻。選択肢が公開されていない場合、この値は意味を持ちません。 |
disabler |
出力のみ。この選択を無効にしたユーザー。オプションが無効になっていない場合、この値は意味を持ちません。 |
disableTime |
出力のみ。この選択が無効になった時刻。選択が無効になっていない場合、この値は意味を持ちません。 |
lockStatus |
出力のみ。この選択の LockStatus。 |
プロパティ
選択した基本プロパティ。
JSON 表現 |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
フィールド | |
---|---|
displayName |
必須。このフィールドを識別する UI に表示される表示テキスト。 |
description |
このラベルの説明。 |
badgeConfig |
この選択肢のバッジの設定。設定すると、この選択肢に付いているラベルが「バッジラベル」と見なされます。 |
insertBeforeChoice |
入力のみ。この選択肢を、指定された選択肢の前に挿入するか移動します。空の場合、選択肢はリストの最後に配置されます。 |
BadgeConfig
ラベルのバッジ ステータス。
JSON 表現 |
---|
{
"color": {
object ( |
フィールド | |
---|---|
color |
バッジの色。指定しない場合、バッジはレンダリングされません。ここで設定された背景、前景、単色(ライトとダークモード)の色は、ドライブの UI で推奨される最も近い色に変更されます。 |
priorityOverride |
このバッジのデフォルトのグローバル優先度をオーバーライドします。0 に設定すると、デフォルトの優先度ヒューリスティックが使用されます。 |
DisplayHints
オプションをレンダリングするための UI 表示ヒント。
JSON 表現 |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
フィールド | |
---|---|
disabled |
オプションを無効にした状態で UI に表示するかどうか。 |
shownInApply |
このオプションは、ドライブのアイテムに値を適用する際に [適用] メニューに表示されます。 |
badgeColors |
バッジに使用する色。選択した |
darkBadgeColors |
バッジに使用するダークモードの色。選択した |
badgePriority |
このバッジの優先度。複数のバッジを比較したり並べ替えたりするために使用します。数字が低いほど、バッジが最初に表示されます。バッジ設定が存在しない場合、これは 0 になります。それ以外の場合は、 |
BadgeColors
BadgeConfig から導出された色が、サポートされている最も近い推奨色に変更されました。
JSON 表現 |
---|
{ "backgroundColor": { object ( |
フィールド | |
---|---|
backgroundColor |
出力のみ。フォアグラウンドと連動するバッジの背景。 |
foregroundColor |
出力のみ。背景とペアになるバッジのフォアグラウンド。 |
soloColor |
出力のみ。背景のないテキストに使用できる色。 |
SchemaCapabilities
選択内容の編集時にこの選択に関連する機能。
JSON 表現 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
フィールド | |
---|---|
canUpdate |
ユーザーがこの選択を更新できるかどうか。 |
canDelete |
ユーザーがこの選択を削除できるかどうか。 |
canDisable |
ユーザーがこの選択を無効にできるかどうかを指定します。 |
canEnable |
ユーザーがこの選択を有効にできるかどうか。 |
AppliedCapabilities
適用されるメタデータに対するこの選択に関連する機能。
JSON 表現 |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
フィールド | |
---|---|
canRead |
ユーザーがアイテムに適用された関連するメタデータの読み取りを許可するかどうか。 |
canSearch |
ユーザーが検索クエリでこの選択を使用できるかどうかを指定します。 |
canSelect |
ユーザーがアイテムでこの選択を選択できるかどうか。 |
LockStatus
ラベル コンポーネントをロックする必要があるかどうかに関する情報が含まれています。
JSON 表現 |
---|
{ "locked": boolean } |
フィールド | |
---|---|
locked |
出力のみ。このラベル コンポーネントが LabelLock の(直接の)ターゲットであるかどうかを示します。ラベル コンポーネントは、LabelLock の直接のターゲットでなくても暗黙的にロックできます。この場合、このフィールドは false に設定されます。 |
UserOptions
ユーザー フィールド タイプのオプション。
JSON 表現 |
---|
{
"listOptions": {
object ( |
フィールド | |
---|---|
listOptions |
指定すると、このフィールドが値のリストをサポートすることを示します。項目が公開されると、変更できなくなります。 |
プロパティ
フィールドの基本プロパティ。
JSON 表現 |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
フィールド | |
---|---|
displayName |
必須。このフィールドを識別する UI に表示される表示テキスト。 |
required |
フィールドを必須としてマークするかどうか。 |
insertBeforeField |
入力のみ。指定されたフィールドの前にこのフィールドを挿入または移動します。空の場合、フィールドはリストの末尾に配置されます。 |
DisplayHints
フィールドをレンダリングするための UI 表示ヒント。
JSON 表現 |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
フィールド | |
---|---|
required |
このフィールドを UI で必須として表示するかどうかを指定します。 |
disabled |
このフィールドを UI で無効として表示するかどうかを指定します。 |
shownInApply |
このフィールドは、ドライブのアイテムに値を適用する際に適用メニューに表示されます。 |
SchemaCapabilities
フィールドの編集時にこのフィールドに関連する機能。
JSON 表現 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
フィールド | |
---|---|
canUpdate |
ユーザーがこのフィールドを変更できるかどうか。 |
canDelete |
ユーザーがこのフィールドを削除できるかどうか。ユーザーには権限があり、フィールドが非推奨である必要があります。 |
canDisable |
ユーザーがこのフィールドを無効にできるかどうかを指定します。ユーザーには権限が必要です。また、このフィールドがすでに無効にされている必要があります。 |
canEnable |
ユーザーがこのフィールドを有効にできるかどうか。ユーザーには権限が必要です。また、このフィールドを無効にする必要があります。 |
AppliedCapabilities
適用されるメタデータのこのフィールドに関連する機能。
JSON 表現 |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
フィールド | |
---|---|
canRead |
ユーザーがアイテムに適用された関連するメタデータの読み取りを許可するかどうか。 |
canSearch |
ユーザーがこのフィールドを参照するドライブのアイテムを検索できるかどうか。 |
canWrite |
ユーザーがドライブのアイテムにこのフィールドを設定できるかどうか。 |
Methods |
|
---|---|
|
新しいラベルを作成します。 |
|
ドライブのアイテムのラベルと関連するメタデータを完全に削除します。 |
|
一連の更新リクエストを適用して 1 つのラベルを更新し、新しい下書きのリビジョンを作成します。 |
|
公開済みのラベルを無効にする。 |
|
無効にしたラベルを有効にして、公開状態に戻します。 |
|
リソース名でラベルを取得します。 |
|
ラベルを一覧表示します。 |
|
すべての下書きの変更をラベルに公開します。 |
|
ラベルの CopyMode を更新します。 |
|
ラベルの権限を更新します。 |