Method: labels.disable

Désactiver un libellé publié Si vous désactivez une étiquette, une nouvelle révision publiée sera créée et désactivée, basée sur la révision publiée actuelle. Si une version brouillon existe, une nouvelle version brouillon désactivée sera créée en fonction de la dernière version brouillon. Les anciennes versions des brouillons seront supprimées.

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

Requête HTTP

POST https://drivelabels.googleapis.com/v2beta/{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. 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érifie que l'utilisateur est administrateur de la balise avant d'autoriser l'accès.

writeControl

object (WriteControl)

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

disabledPolicy

object (DisabledPolicy)

Règle désactivée à utiliser.

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 sont 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.