Method: labels.delta

Met à jour un seul libellé en appliquant un ensemble de requêtes de mise à jour, ce qui génère une nouvelle révision provisoire. Pour en savoir plus, consultez Mettre à jour un libellé.

La mise à jour par lot est tout ou rien : si l'une des demandes de mise à jour n'est pas valide, aucune modification n'est appliquée. Le brouillon de révision obtenu doit être publié pour que les modifications puissent être utilisées avec les éléments Drive.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource du libellé à modifier.

Corps de la requête

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

Représentation JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Champs
writeControl

object (WriteControl)

Permet de contrôler l'exécution des requêtes d'écriture.
requests[]

object (Request)

Liste des mises à jour à appliquer au libellé. Les demandes seront appliquées dans l'ordre dans lequel elles sont spécifiées.
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.
view

enum (LabelView)

Si ce paramètre est spécifié, seuls certains champs appartenant à la vue indiquée seront renvoyés.
languageCode

string

Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés lorsque include_label_in_response est défini sur true.

Corps de la réponse

Réponse pour la mise à jour du libellé.

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

Représentation JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Champs
responses[]

object (Response)

Réponse aux mises à jour. Cette valeur correspond à une mise à jour, même si la réponse à certaines requêtes peut être vide.
updatedLabel

object (Label)

Libellé après l'application des modifications. Ce champ n'est défini que si include_label_in_response est true et qu'aucune erreur ne s'est produite.

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.

Requête

Type de mise à jour à appliquer à un libellé.

Représentation JSON 
{

  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
}
Champs
Champ d'union kind. Type de mise à jour. Un seul champ est requis. kind ne peut être qu'un des éléments suivants :
updateLabel

object (UpdateLabelPropertiesRequest)

Met à jour les propriétés du libellé.
createField

object (CreateFieldRequest)

Crée un champ.
updateField

object (UpdateFieldPropertiesRequest)

Met à jour les propriétés de base d'un champ.
updateFieldType

object (UpdateFieldTypeRequest)

Modifiez le type de champ et/ou les options de type.
enableField

object (EnableFieldRequest)

Active le champ.
disableField

object (DisableFieldRequest)

Désactive le champ.
deleteField

object (DeleteFieldRequest)

Supprime un champ du libellé.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Créez un choix dans un champ de sélection.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Mettez à jour une propriété de choix dans un champ de sélection.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Activez un choix dans un champ de sélection.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Désactivez un choix dans un champ de sélection.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Supprimez un choix dans un champ de sélection.

UpdateLabelPropertiesRequest

Met à jour les propriétés de base d'un libellé.

Représentation JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. Le label_properties racine est implicite et ne doit pas être spécifié. Un seul * peut être utilisé comme raccourci pour mettre à jour tous les champs.
properties

object (Properties)

Obligatoire. Propriétés du libellé à mettre à jour.

CreateFieldRequest

Requête de création d'un champ dans un libellé.

Représentation JSON 
{
  "field": {
    object (Field)
  }
}
Champs
field

object (Field)

Obligatoire. Champ à créer.

UpdateFieldPropertiesRequest

Requête de mise à jour des propriétés de champ.

Représentation JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. Le properties racine est implicite et ne doit pas être spécifié. Un seul * peut être utilisé comme raccourci pour mettre à jour tous les champs.
id

string

Obligatoire. Champ à mettre à jour.
properties

object (Properties)

Obligatoire. Propriétés de base des champs.

UpdateFieldTypeRequest

Demande de modification du type d'un champ.

Représentation JSON 
{
  "updateMask": string,
  "id": string,

  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine de type_options est implicite et ne doit pas être spécifiée. Un seul * peut être utilisé comme raccourci pour mettre à jour tous les champs.
id

string

Obligatoire. Champ à mettre à jour.

Champ d'union type_options.

type_options ne peut être qu'un des éléments suivants :
textOptions

object (TextOptions)

Définissez le champ sur "Texte".
integerOptions

object (IntegerOptions)

Mettez à jour le champ sur "Entier".
dateOptions

object (DateOptions)

Définissez le champ sur "Date".
selectionOptions

object (SelectionOptions)

Mettez à jour le champ sur "Sélection".
userOptions

object (UserOptions)

Définissez le champ sur "Utilisateur".

EnableFieldRequest

Demandez à activer le champ.

Représentation JSON 
{
  "id": string
}
Champs
id

string

Obligatoire. ID du champ à activer.

DisableFieldRequest

Demande de désactivation du champ.

Représentation JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
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.
id

string

Obligatoire. Clé du champ à désactiver.
disabledPolicy

object (DisabledPolicy)

Obligatoire. Règle de champ désactivé.

DeleteFieldRequest

Demande de suppression du champ.

Représentation JSON 
{
  "id": string
}
Champs
id

string

Obligatoire. ID du champ à supprimer.

CreateSelectionChoiceRequest

Requête de création d'un choix de sélection.

Représentation JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Champs
fieldId

string

Obligatoire. Champ de sélection dans lequel un choix sera créé.
choice

object (Choice)

Obligatoire. Le choix de créer.

UpdateSelectionChoicePropertiesRequest

Requête de mise à jour d'une propriété de choix.

Représentation JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. Le properties racine est implicite et ne doit pas être spécifié. Un seul * peut être utilisé comme raccourci pour mettre à jour tous les champs.
fieldId

string

Obligatoire. Champ de sélection à mettre à jour.
id

string

Obligatoire. Choix de la mise à jour.
properties

object (Properties)

Obligatoire. Propriétés de choix à mettre à jour.

EnableSelectionChoiceRequest

Demandez à activer un choix.

Représentation JSON 
{
  "fieldId": string,
  "id": string
}
Champs
fieldId

string

Obligatoire. Champ de sélection dans lequel un choix sera activé.
id

string

Obligatoire. Vous pouvez choisir de l'activer.

DisableSelectionChoiceRequest

Demande de désactivation d'un choix.

Représentation JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
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.
fieldId

string

Obligatoire. Champ de sélection dans lequel un choix sera désactivé.
id

string

Obligatoire. Vous pouvez désactiver cette fonctionnalité.
disabledPolicy

object (DisabledPolicy)

Obligatoire. Règle désactivée à modifier.

DeleteSelectionChoiceRequest

Demande de suppression d'un choix.

Représentation JSON 
{
  "fieldId": string,
  "id": string
}
Champs
fieldId

string

Obligatoire. Champ de sélection à partir duquel un choix sera supprimé.
id

string

Obligatoire. Vous pouvez choisir de supprimer les données.

Réponse

Réponse unique à une mise à jour.

Représentation JSON 
{

  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
}
Champs
Champ d'union response. Réponse à la requête correspondante. response ne peut être qu'un des éléments suivants :
updateLabel

object (UpdateLabelPropertiesResponse)

Met à jour les propriétés de base d'un libellé.
createField

object (CreateFieldResponse)

Crée un champ.
updateField

object (UpdateFieldPropertiesResponse)

Met à jour les propriétés de base d'un champ.
updateFieldType

object (UpdateFieldTypeResponse)

Met à jour le type de champ et/ou les options de type.
enableField

object (EnableFieldResponse)

Active le champ.
disableField

object (DisableFieldResponse)

Désactive le champ.
deleteField

object (DeleteFieldResponse)

Supprime un champ du libellé.
createSelectionChoice

object (CreateSelectionChoiceResponse)

Crée une option de liste de sélection à ajouter à un champ de sélection.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Met à jour un choix dans un champ de sélection.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Permet de faire un choix dans un champ de sélection.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Désactive un choix dans un champ de sélection.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Supprime un choix dans un champ de sélection.

UpdateLabelPropertiesResponse

Ce type ne comporte aucun champ.

Réponse suite à la mise à jour des propriétés du libellé.

CreateFieldResponse

Réponse après la création du champ.

Représentation JSON 
{
  "id": string,
  "priority": integer
}
Champs
id

string

Champ du champ créé. Si vous ne renseignez pas ce champ dans une demande de création, une clé sera générée automatiquement et pourra être identifiée ici.
priority

integer

Priorité du champ créé. La priorité peut être modifiée par rapport à celle spécifiée pour assurer des priorités contiguës entre les champs (de 1 à n).

UpdateFieldPropertiesResponse

Réponse suite à la mise à jour des propriétés du champ.

Représentation JSON 
{
  "priority": integer
}
Champs
priority

integer

Priorité du champ mis à jour. La priorité peut être modifiée par rapport à celle spécifiée pour assurer des priorités contiguës entre les champs (de 1 à n).

UpdateFieldTypeResponse

Ce type ne comporte aucun champ.

Réponse suite à la modification du type de champ.

EnableFieldResponse

Ce type ne comporte aucun champ.

Réponse après l'activation du champ.

DisableFieldResponse

Ce type ne comporte aucun champ.

Réponse après la désactivation d'un champ.

DeleteFieldResponse

Ce type ne comporte aucun champ.

Réponse après la suppression d'un champ.

CreateSelectionChoiceResponse

Réponse après la création d'un choix de sélection.

Représentation JSON 
{
  "fieldId": string,
  "id": string
}
Champs
fieldId

string

ID du champ généré par le serveur.
id

string

ID généré par le serveur du choix créé dans le champ.

UpdateSelectionChoicePropertiesResponse

Réponse après la mise à jour des propriétés de choix de sélection.

Représentation JSON 
{
  "priority": integer
}
Champs
priority

integer

Priorité du choix modifié. La priorité peut être modifiée par rapport à celle spécifiée pour assurer des priorités contiguës entre les choix (de 1 à n).

EnableSelectionChoiceResponse

Ce type ne comporte aucun champ.

Réponse après l'activation du choix.

DisableSelectionChoiceResponse

Ce type ne comporte aucun champ.

Réponse après la désactivation du choix.

DeleteSelectionChoiceResponse

Ce type ne comporte aucun champ.

Réponse après la suppression d'un choix.