ラベルを作成して公開

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

ラベルを作成する

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

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

  • A 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 リストから 1 つ以上のオプションを選択する サポートされるオプションの最大数は 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 メソッドを使用して次の項目を指定します。

  • すべてのラベルを表すラベルリソース 。これには、リソースの 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 が変更されます。
    • フィールドの検証オプションを更新すると、以前に受け入れられたものが拒否されます。
    • 最大エントリ数の削減。