Method: files.modifyLabels

Modifie l'ensemble des libellés appliqués à un fichier. Affiche la liste des libellés ajoutés ou modifiés.

Requête HTTP

POST https://www.googleapis.com/drive/v3/files/{fileId}/modifyLabels

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
fileId

string

Identifiant du fichier auquel appartiennent les libellés.

Corps de la requête

Le corps de la requête contient une instance de ModifyLabelsRequest.

Corps de la réponse

Réponse à une requête files.modifyLibellés. Elle ne contient que les libellés qui ont été ajoutés ou mis à jour par la requête.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
Champs
modifiedLabels[]

object (Label)

Liste des étiquettes ajoutées ou mises à jour par la requête.
kind

string

Il s'agit toujours de drive#modifyLibellésResponse.

Champs d'application des autorisations

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

Certains champs d'application sont restreints et nécessitent une évaluation de sécurité pour que votre application puisse les utiliser. Pour en savoir plus, consultez le Guide relatif aux autorisations.

ModifyLabelsRequest

Requête permettant de modifier l'ensemble d'étiquettes d'un fichier. Cette requête peut contenir de nombreuses modifications qui vont toutes réussir ou toutes échouer de manière atomique.

Représentation JSON 
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
Champs
labelModifications[]

object (LabelModification)

Liste des modifications à appliquer aux étiquettes du fichier.
kind

string

Il s'agit toujours de drive#modifyLibellésRequest.

LabelModification

Modification d'un libellé dans un fichier. La fonctionnalité LabelModification permet d'appliquer un libellé à un fichier, de mettre à jour un libellé existant dans un fichier ou de supprimer un libellé d'un fichier.

Représentation JSON 
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
Champs
labelId

string

ID du libellé à modifier.
fieldModifications[]

object (FieldModification)

Liste des modifications apportées aux champs de ce libellé.
removeLabel

boolean

Si la valeur est "true", le libellé est supprimé du fichier.
kind

string

Il s'agit toujours de drive#labelModification.

FieldModification

Modification du champ d'un libellé.

Représentation JSON 
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
Champs
fieldId

string

Identifiant du champ à modifier.
kind

string

Il s'agit toujours de drive#labelFieldModification.
setDateValues[]

string

Remplace la valeur d'un champ date par ces nouvelles valeurs. La chaîne doit être au format de date complète RFC 3339: AAAA-MM-JJ.
setTextValues[]

string

Définit la valeur d'un champ text.
setSelectionValues[]

string

Remplace un champ selection par ces nouvelles valeurs.
setIntegerValues[]

string (int64 format)

Remplace la valeur d'un champ integer par ces nouvelles valeurs.
setUserValues[]

string

Remplace un champ user par ces nouvelles valeurs. Les valeurs doivent être des adresses e-mail valides.
unsetValues

boolean

Annule la définition des valeurs de ce champ.