このページでは、ラベルに関連する次のタスクを行う方法について説明します。
- ラベルを無効にする
- ラベルを有効にする
- ラベルを削除する
ラベルを無効にする
ラベルを無効にすると、現在の公開済みリビジョンに基づいて、新しい無効の公開済みリビジョンが作成されます。下書きリビジョンがある場合は、最新の下書きリビジョンに基づいて、新しい無効な下書きリビジョンが作成されます。古いドラフト リビジョンは削除されます。詳細については、ラベルのライフサイクルをご覧ください。
無効にしても、ユーザーは API を通じてこのラベルを適用できます。無効にしたラベルは、すでに適用されている場所と検索結果には引き続き表示されます。無効なラベルは削除できます。
公開済みのラベルを無効にするには、labels コレクションの disable メソッドを使用します。
また、次の指定も必要です。
すべてのラベルを表すラベル リソース。これには、リソース
Nameと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 を介してラベルを適用できます。ただし、disabledPolicy メソッドの showInApply プロパティが構成されていない限り、無効なラベルは UI に表示されません。
ラベルを有効にする
無効なラベルを有効にすると、公開状態に戻ります。これにより、現在無効になっている公開済みリビジョンに基づいて、新しい公開済みリビジョンが作成されます。無効な下書きリビジョンが既存の場合、その下書きに基づいて新しいリビジョンが作成され、有効になります。詳細については、ラベルのライフサイクルをご覧ください。
無効にしたラベルを有効にするには、enable メソッドを使用します。
また、次の指定も必要です。
すべてのラベルを表すラベル リソース。これには、リソース
Nameと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（ラベルのグローバルに一意の識別子）が含まれます。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 が増分されます。ラベルを適用することはできません。削除されたラベルは最終的に削除されます。詳細については、ラベルのライフサイクルをご覧ください。