Method: labels.disable

公開済みのラベルを無効にします。詳細については、ラベルを無効化、有効化、削除するをご覧ください。

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

無効にすると、labels.delete でラベルを削除できます。

HTTP リクエスト

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:disable

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。ラベル リソース名。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "updateMask": string,
  "useAdminAccess": boolean,
  "writeControl": {
    object (WriteControl)
  },
  "disabledPolicy": {
    object (DisabledPolicy)
  },
  "languageCode": string
}
フィールド
updateMask

string (FieldMask format)

更新するフィールド。少なくとも 1 つのフィールドを指定する必要があります。ルート disabledPolicy は暗黙的に指定されるため、指定しないでください。1 つの * を使用して、すべてのフィールドを更新するショートハンドとして使用できます。
useAdminAccess

boolean

ユーザーの管理者認証情報を使用するには、true に設定します。サーバーは、アクセスを許可する前に、ユーザーがラベルの管理者であることを確認します。
writeControl

object (WriteControl)

書き込みリクエストの実行方法を制御します。デフォルトは未設定です。つまり、最後の書き込みが優先されます。
disabledPolicy

object (DisabledPolicy)

使用する無効なポリシー。
languageCode

string

ローカライズされたフィールド ラベルの評価に使用する BCP-47 言語コード。指定しない場合は、デフォルトで構成された言語の値が使用されます。

レスポンスの本文

成功した場合、レスポンスの本文には Label のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

詳しくは、承認ガイドをご覧ください。