ファイルからラベルを削除する

このページでは、単一の Google ドライブ ファイルのラベルを削除する方法について説明します。

ファイルからファイルラベルのメタデータを削除するには、files.modifyLabels メソッドを使用します。リクエストの本文には、ファイルに設定されたラベルを変更するための ModifyLabelsRequest のインスタンスが含まれます。リクエストには、アトミックに適用される複数の変更が含まれている場合があります。つまり、無効な変更が 1 つでもあれば、更新全体が失敗し、（依存関係がある可能性のある）変更は適用されません。

ModifyLabelsRequest には、ファイル上のラベルの変更である LabelModification のインスタンスが含まれています。ラベルのフィールドの変更である FieldModification のインスタンスが含まれる場合もあります。ファイルからラベルを削除するには、FieldModification.removeLabel を True に設定します。

成功した場合、レスポンスの本文には、リクエストによって追加または更新されたラベルが含まれます。これらは、Label タイプの modifiedLabels オブジェクト内に存在します。

例

次のコードサンプルは、labelId を使用して、fileId を使用してラベルに関連付けられたすべてのフィールドを削除する方法を示しています。たとえば、ラベルにテキスト フィールドとユーザー フィールドの両方が含まれている場合、ラベルを削除すると、そのラベルに関連付けられているテキスト フィールドとユーザー フィールドの両方が削除されます。一方、テキスト フィールドの設定を解除すると、ラベルからテキスト フィールドが削除されますが、ユーザー フィールドはそのまま残ります。詳細については、ファイルのラベル フィールドの設定を解除するをご覧ください。

Java

ModifyLabelsRequest modifyLabelsRequest =
  new ModifyLabelsRequest()
      .setLabelModifications(
          ImmutableList.of(
              new LabelModification()
                .setLabelId("LABEL_ID")
                .setRemoveLabel(true)));

ModifyLabelsResponse modifyLabelsResponse = driveService.files().modifyLabels("FILE_ID", modifyLabelsRequest).execute();

Python

label_modification = {'labelId':'LABEL_ID', 'removeLabel': True]}

modified_labels = drive_service.files().modifyLabels(fileId="FILE_ID", body = {'labelModifications' : [label_modification]}).execute();

Node.js

/**
* Remove a label on a Drive file
* @return{obj} updated label data
**/
async function removeLabel() {
  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app

  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  const auth = new GoogleAuth({scopes: 'https://www.googleapis.com/auth/drive'});
  const service = google.drive({version: 'v3', auth});
  const labelModification = {
    'labelId': 'LABEL_ID',
    'removeLabel': True,
  };
  const labelModificationRequest = {
    'labelModifications': [labelModification],
  };
  try {
    const updateResponse = await service.files.modifyLabels({
      fileId: 'FILE_ID',
      resource: labelModificationRequest,
    });
    return updateResponse;
  } catch (err) {
    // TODO (developer) - Handle error
    throw err;
  }

次のように置き換えます。

• LABEL_ID: 変更するラベルの labelId。ファイル内のラベルを見つけるには、files.listLabels メソッドを使用します。
• FILE_ID: ラベルが変更されたファイルの fileId。