このページは Cloud Translation API によって翻訳されました。

ラベルを作成して公開

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

ラベルを作成する

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

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

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

この例では、指定されたタイトルと 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 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 が変更された。
- フィールド検証オプションを更新すると、以前に承認したものが拒否されます。
- 最大エントリ数の削減。