ラベルを作成して公開する

このページでは、ラベルを作成して公開する方法について説明します。

ラベルを作成する

ラベルを作成するには、labels コレクションの create メソッドを使用します。ラベルには、必要に応じて 1 つ以上の Fields を含めることができます。

以下も指定する必要があります。

LabelType。
property メソッドを介したラベル title。
useAdminAccess は、ユーザーの管理者認証情報を使用する true です。サーバーはユーザーが「ラベルの管理」権限を持つ管理者であることを確認したうえで、アクセスを許可します。

この例では、指定されたタイトルと 2 つの Choices を持つ 1 つの SelectionOptions Field の標準標準ラベルを作成します。

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

service.labels.create({
  'resource': label,
  'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ラベルは UNPUBLISHED_DRAFT State で作成されます。ファイルで PUBLISHED を使用し、ユーザーに表示する。詳細については、ラベルのライフサイクルをご覧ください。

ラベルの制限

ラベルを作成して適用する場合、次の上限が適用されます。

標準ラベル - 150
ラベルあたりのフィールド数 - 10
ユーザーが適用したファイルあたりのラベル数 - 5

ラベルの項目を操作する

`Field Type`	ユーザーができること	形式に関する考慮事項と制限
`SelectionOptions`	リストからオプションを選択する（複数可）	サポートされるオプションの最大数は 200 個です。 `ListOptions` で構成したファイルの最大選択数は 10 個です。
`IntegerOptions`	数値を入力してください	整数のみ入力できます
`DateOptions`	カレンダーの日付を選択する	（省略可）`Date format` を [Long: Month DD, YYYY] または [Short: MM/DD/YY] に設定できます
`TextOptions`	テキストボックスにテキストを入力する	最大文字数は 100 文字です
`UserOptions`	Google Workspace の連絡先から 1 人以上のユーザーを選択します。	`ListOptions` で設定されたファイルのユーザーエントリの最大数は 10 です。

ラベルを公開する

Labels API では、処理が完了してから下書きのラベルを公開できます。

ラベルを公開するには、publish メソッドを使用して、以下を指定します。

すべてのラベルを表す Label リソース。これには、ラベルのグローバルに一意の識別子である Name と ID が含まれます。
useAdminAccess は、ユーザーの管理者認証情報を使用する true です。サーバーはユーザーが「ラベルの管理」権限を持つ管理者であることを確認したうえで、アクセスを許可します。

この例では、ID を使用して正しいラベルを識別し、公開しています。

Python

service.labels().publish(
name='labels/ID',
body={
  'use_admin_access': True
}).execute()

Node.js

service.labels.publish({
  'resource': {
    'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ラベルが公開されると、ラベルは PUBLISHED State に移動し、ラベルのリビジョン ID が増加します。ラベルはユーザーに表示され、ファイルに適用できます。詳細については、ラベルのライフサイクルをご覧ください。

ラベルを公開する際の制約

公開後は、ラベルを元の下書きの状態に戻すことはできません。詳細については、ラベルのライフサイクルをご覧ください。
ラベルを公開すると、新たに公開されたリビジョンが作成されます。以前のドラフトのリビジョンはすべて削除されます。以前に公開されたリビジョンは保持されますが、必要に応じて自動削除の対象となります。
公開すると、一部の変更は許可されなくなります。通常、これは、ラベルに関連する既存のメタデータを無効化またはトリガーする変更を拒否します。たとえば、ラベルを公開した後でラベルに次のような変更を加えることはできません。
- ラベルは直接削除されます。（まず無効にしてから削除する必要があります）。
- Field.FieldType が変更されました。
- フィールド検証オプションの更新により、これまで許容されていた内容が拒否されます。
- 最大エントリ数の減少。