このページでは、ラベルに関連する次のタスクを行う方法について説明します。
- ラベルを無効にする
- ラベルを有効にする
- ラベルを削除する
ラベルを無効にする
ラベルを無効にすると、現在の公開済みリビジョンに基づいて、無効な新しい公開済みリビジョンが作成されます。下書きリビジョンがある場合は、最新の下書きリビジョンに基づいて、無効な新しい下書きリビジョンが作成されます。古い下書きリビジョンは削除されます。詳細については、ラベル のライフサイクルをご覧ください。
無効にしても、ユーザーは API を介してこのラベルを適用できます。ラベルは、すでに適用されている場所と検索結果に引き続き表示されます。無効にした ラベルは削除できます。
公開済みラベルを無効にするには、
disable メソッドを
labels コレクションで使用します。
次の項目も指定する必要があります。
すべてのラベルを表すラベルリソース 。これには、リソースの
NameとIDが含まれます。IDは、ラベルのグローバルに一意の識別子です。useAdminAccessは、ユーザーの管理者認証情報を使用する場合はtrueです。サーバーは、アクセスを許可する前に、ユーザーがラベルの管理者であることを確認します。
この例では、ID を使用して正しいラベルを無効にします。
Python
service.labels().disable(
name='labels/ID',
body={
'use_admin_access': True
}).execute()
Node.js
service.labels.disable({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
ラベルの State は
DISABLED になり、ラベルのリビジョン ID が増えます。ユーザーは API を介してラベルを適用できます。ただし、無効にしたラベルは UI に表示されません。
showInApply メソッドの
disabledPolicy プロパティ
が構成されていない限り。
ラベルを有効にする
無効にしたラベルを有効にすると、公開済みの状態に戻ります。現在の無効な公開済みリビジョンに基づいて、新しい公開済みリビジョンが作成されます。無効な下書きリビジョンが既存する場合は、その下書きに基づいて新しいリビジョンが作成され、有効になります。詳細については、ラベル のライフサイクルをご覧ください。
無効にしたラベルを有効にするには、
enable メソッドを使用します。
次の項目も指定する必要があります。
すべてのラベルを表すラベルリソース 。これには、リソースの
NameとIDが含まれます。IDは、ラベルのグローバルに一意の識別子です。useAdminAccessは、ユーザーの管理者認証情報を使用する場合はtrueです。サーバーは、アクセスを許可する前に、ユーザーがラベルの管理者であることを確認します。
この例では、ID を使用して正しいラベルを有効にします。
Python
service.labels().enable(
name='labels/ID',
body={
'use_admin_access': True
}).execute()
Node.js
service.labels.enable({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
ラベルの State は
PUBLISHED になり、ラベルのリビジョン ID が増えます。ユーザーは API を介してラベルを表示し、ファイルに適用できます。
ラベルを削除する
削除できるのは、下書きラベルと無効にしたラベルのみです。ラベルを削除すると、そのラベルが適用されていたすべてのインスタンス（ユーザーが入力した、対応する項目値を含む）が完全に削除され、それらのドライブ ファイルから消去されます。
ラベルを削除するには、まずラベルを無効にしてから、
delete メソッドを使用する必要があります。
次の項目も指定する必要があります。
すべてのラベルを表すラベルリソース 。これには、リソースの
NameとIDが含まれます。IDは、ラベルのグローバルに一意の識別子です。useAdminAccessは、ユーザーの管理者認証情報を使用する場合はtrueです。サーバーは、アクセスを許可する前に、ユーザーがラベルの管理者であることを確認します。
この例では、ID を使用して正しいラベルを削除します。
Python
response = service.labels().delete(
name='labels/ID',
useAdminAccess=True).execute()
Node.js
service.labels.delete({
'name': 'labels/ID',
'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
ラベルの State は
DELETED になり、ラベルのリビジョン ID が増えます。ラベルは適用できず、削除されたラベルは最終的に削除されます。詳細については、
ラベルのライフサイクルをご覧ください。