このページでは、ラベルに関連する次のタスクを行う方法について説明します。
- ラベルを無効にする
- ラベルを有効にする
- ラベルを削除する
ラベルを無効にする
ラベルを無効にすると、現在公開中のリビジョンに基づいて、無効化された新しい公開リビジョンが作成されます。下書きのリビジョンがある場合は、最新の下書きのリビジョンに基づいて、無効になっている新しい下書きのリビジョンが作成されます。古い下書きのリビジョンは削除されます。詳細については、ラベルのライフサイクルをご覧ください。
無効にしても、ユーザーは引き続き 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 が増分します。ラベルは適用できず、削除されたラベルは最終的に完全に削除されます。詳細については、ラベルのライフサイクルをご覧ください。