ラベルを作成して公開

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

ラベルを作成する

ラベルを作成するには、 次のオブジェクトの create メソッド: labels コレクション。ラベルは 必要に応じて 1 つ以上の Fields

次の項目も指定する必要があります。

  • LabelType

  • ラベル title property メソッドを使用します。

  • ユーザーの管理者認証情報を使用する場合、useAdminAccesstrue です。「 サーバーが、ユーザーが「ラベルの管理」権限を持つ管理者であることを確認します。権限 アクセスを許可する必要があります。

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

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 に作成されます。 StatePUBLISHED にする必要があります。 ファイルで使用したりユーザーに表示したりできます。詳細については、ラベル 説明します

ラベルの上限

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

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

ラベルのフィールドの操作

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

ラベルを公開する

Labels API を使用すると、完成したラベルの下書きを公開できます。

ラベルを公開するには、 publish メソッドを呼び出し、次を指定します。

  • ラベルリソース ラベルを表す名前です。これには、リソース NameID が含まれています。 ラベルのグローバルに一意の識別子です。

  • ユーザーの管理者認証情報を使用する場合、useAdminAccesstrue です。「 サーバーが、ユーザーが「ラベルの管理」権限を持つ管理者であることを確認します。権限 アクセスを許可してください。

この例では、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 が増加します。ラベルはユーザーに表示され、ラベルを適用できるようになります。 できます。詳細については、ラベル 説明します

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

  • 公開すると、ラベルを元の下書き状態に戻すことはできません。詳細情報 詳しくは、ラベルのライフサイクルをご覧ください。

  • ラベルを公開すると、新たに公開済みのリビジョンが作成されます。以前のすべての下書き 削除されます。以前に公開されたリビジョンは保持されますが、 必要に応じて自動削除されます

  • 公開すると、一部の変更は許可されなくなります。一般的にこれは 既存のポリシーに対する新しい制限を無効化またはトリガーする変更 拒否されます。たとえば、次のようになります。 ラベルの公開後にラベルを変更することはできません。

    • ラベルが直接削除されます。(最初に無効にしてから、 deleted.)
    • Field.FieldType が変更された。
    • フィールドの入力規則を更新すると、以前内容が拒否される 拒否されます。
    • 最大エントリ数の減少。