Method: labels.disable

Désactiver un libellé publié La désactivation d'un libellé entraînera la désactivation d'une nouvelle révision publiée sur la base de la révision actuellement publiée. S'il existe une révision de brouillon, une nouvelle révision de brouillon désactivée sera créée à partir de la dernière révision brouillon. Les révisions du brouillon plus anciennes seront supprimées.

Une fois désactivé, un libellé peut être supprimé avec labels.delete.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de la ressource d'étiquette.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "updateMask": string,
  "useAdminAccess": boolean,
  "writeControl": {
    object (WriteControl)
  },
  "disabledPolicy": {
    object (DisabledPolicy)
  },
  "languageCode": string
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine disabledPolicy est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.
useAdminAccess

boolean

Définissez la valeur sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur du libellé avant d'autoriser l'accès.
writeControl

object (WriteControl)

Permet de contrôler la manière dont les requêtes d'écriture sont exécutées. La valeur par défaut n'est pas définie, ce qui signifie que la dernière écriture l'emporte.
disabledPolicy

object (DisabledPolicy)

Règle à utiliser désactivée.
languageCode

string

Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés. Si aucune valeur n'est spécifiée, les valeurs dans la langue configurée par défaut seront utilisées.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Label.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide relatif aux autorisations.