Method: labels.disable

Désactivez un libellé publié. Pour en savoir plus, consultez Désactiver, activer et supprimer un libellé.

La désactivation d'un libellé entraîne la publication d'une nouvelle révision désactivée basée sur la révision publiée actuelle. S'il existe une révision brouillon, une nouvelle révision brouillon désactivée sera créée sur la base de la dernière révision brouillon. Les anciennes révisions de brouillons seront supprimées.

Une fois désactivé, un libellé peut être supprimé à l'aide de 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 de libellé.

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. Le disabledPolicy racine est implicite et ne doit pas être spécifié. Un seul * peut être utilisé comme raccourci pour mettre à jour tous les champs.
useAdminAccess

boolean

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

object (WriteControl)

Permet de contrôler l'exécution des requêtes d'écriture. La valeur par défaut est "non défini", ce qui signifie que la dernière écriture l'emporte.
disabledPolicy

object (DisabledPolicy)

Règle à désactiver.
languageCode

string

Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés. Si aucune langue n'est spécifiée, les valeurs de 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 d'autorisation.