ラベルを無効にする、有効にする、削除する

このドキュメントでは、ラベルに関する次のタスクを行う方法について説明します。

  • ラベルを無効にする
  • ラベルを有効にする
  • ラベルを削除する

ラベルを無効にする

ラベルを無効にすると、現在の公開済みリビジョンに基づいて、無効な新しい公開済みリビジョンが作成されます。下書きリビジョンがある場合は、最新の下書きリビジョンに基づいて、無効な新しい下書きリビジョンが作成されます。古い下書きリビジョンは削除されます。詳細については、ラベル のライフサイクルをご覧ください。

無効にしても、ユーザーは Google ドライブ Labels API を使用してこのラベルを適用できます。ラベルは、すでに適用されている場所や検索結果に引き続き表示されます。 無効なラベルは削除できます。

公開済みラベルを無効にするには、 disable メソッドを labels リソースで使用します。

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

  • ラベルを表す labels リソース。これには、name と idが含まれます。 は、ラベルのグローバルに一意の識別子です。

  • useAdminAccess クエリ パラメータは、ユーザーの管理者 認証情報を使用するように true に設定されています。アクセスを許可する前に、ユーザーに必要な 分類ラベルの管理 の管理者権限があることをサーバーが確認します。

次のコードサンプルは、ラベルの id を使用して正しいラベルを無効にする方法を示しています。

Python

service.labels().disable(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.disable({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ID は、無効にするラベルの ID に置き換えます。

ラベルの State は DISABLED になり、ラベルのリビジョン ID が増えます。ユーザーは Drive Labels API を使用してラベルを適用できます。ただし、無効なラベルは、 オブジェクトの DisabledPolicy フィールドが構成されていない限り、UI には表示されません。showInApply

ラベルを有効にする

無効なラベルを有効にすると、公開済みの状態に戻ります。現在の無効な公開済みリビジョンに基づいて、新しい公開済みリビジョンが作成されます。既存の無効な下書きリビジョンがある場合は、その下書きに基づいて新しいリビジョンが作成され、有効になります。詳細については、ラベル のライフサイクルをご覧ください。

無効なラベルを有効にするには、 enable メソッドを labels リソースで使用します。

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

  • ラベルを表す labels リソース。これには、name と idが含まれます。 は、ラベルのグローバルに一意の識別子です。

  • useAdminAccess クエリ パラメータは、ユーザーの管理者 認証情報を使用するように true に設定されています。アクセスを許可する前に、ユーザーに必要な 分類ラベルの管理 の管理者権限があることをサーバーが確認します。

次のコードサンプルは、ラベルの id を使用して正しいラベルを有効にする方法を示しています。

Python

service.labels().enable(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.enable({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ID は、有効にするラベルの ID に置き換えます。

ラベルの StateはPUBLISHED になり、ラベルのリビジョン ID が増えます。ユーザーは Drive Labels API を使用してラベルを表示し、ファイルに適用できます。

ラベルを削除する

削除できるのは、下書きラベルと無効なラベルのみです。ラベルを削除すると、そのラベルが適用されていたすべてのインスタンス（ユーザーが入力した、対応する項目値を含む）が完全に削除され、それらのドライブ ファイルから消去されます。

ラベルを削除するには、まずラベルを無効にしてから、 delete メソッドを labels リソースで使用する必要があります。

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

  • ラベルを表す labels リソース。これには、name と idが含まれます。 は、ラベルのグローバルに一意の識別子です。

  • useAdminAccess クエリ パラメータは、ユーザーの管理者 認証情報を使用するように true に設定されています。アクセスを許可する前に、ユーザーに必要な 分類ラベルの管理 の管理者権限があることをサーバーが確認します。

次のコードサンプルは、ラベルの id を使用して正しいラベルを削除する方法を示しています。

Python

response = service.labels().delete(
    name='labels/ID',
    useAdminAccess=True
).execute()

Node.js

service.labels.delete({
  name: 'labels/ID',
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ID は、削除するラベルの ID に置き換えます。

ラベルの StateはDELETED になり、ラベルのリビジョン ID が増えます。ラベルを適用することはできません。削除されたラベルは最終的に削除されます。詳細については、ラベル のライフサイクルをご覧ください。