Method: files.modifyLabels

Modifie l'ensemble des libellés appliqués à un fichier. Renvoie une liste des libellés qui ont été 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

ID 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.modifyLabels. Il ne contient que les libellés ajoutés ou modifiés 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 libellés ajoutés ou modifiés par la requête.
kind

string

Il s'agit toujours de drive#modifyLabelsResponse.

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 sont soumis à des restrictions et nécessitent une évaluation de sécurité pour que votre application puisse les utiliser. Pour en savoir plus, consultez le guide d'autorisation.

ModifyLabelsRequest

Requête permettant de modifier l'ensemble des libellés d'un fichier. Cette requête peut contenir de nombreuses modifications qui réussiront ou échoueront toutes de manière atomique.

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

object (LabelModification)

Liste des modifications à appliquer aux libellés du fichier.
kind

string

Il s'agit toujours de drive#modifyLabelsRequest.

LabelModification

Modification d'un libellé sur un fichier. Une modification de libellé peut être utilisée pour appliquer un libellé à un fichier, mettre à jour un libellé existant sur un fichier ou supprimer un libellé d'un fichier.

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

object (FieldModification)

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

string

ID du libellé à modifier.
removeLabel

boolean

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

string

Il s'agit toujours de drive#labelModification.

FieldModification

Modification d'un champ de libellé.

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

string

Remplace la valeur d'un champ date par ces nouvelles valeurs. La chaîne doit être au format 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.
fieldId

string

ID du champ à modifier.
kind

string

Il s'agit toujours de drive#labelFieldModification.
unsetValues

boolean

Supprime les valeurs de ce champ.