- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Requête
- UpdateLabelPropertiesRequest
- CreateFieldRequest
- UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- LongTextOptions
- EnableFieldRequest
- DisableFieldRequest
- DeleteFieldRequest
- CreateSelectionChoiceRequest
- UpdateSelectionChoicePropertiesRequest
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- DeleteSelectionChoiceRequest
- Réponse
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- DeleteFieldResponse
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- DeleteSelectionChoiceResponse
- Essayer
Met à jour un seul libellé en appliquant un ensemble de demandes de mise à jour, ce qui génère une nouvelle révision du brouillon. La mise à jour groupée 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 la révision doit être publié pour que les modifications puissent être utilisées avec des é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 |
Obligatoire. Nom de ressource du libellé à mettre à jour. |
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 ( |
Champs | |
---|---|
writeControl |
Permet de contrôler la manière dont les requêtes d'écriture sont exécutées. |
requests[] |
Liste des mises à jour à appliquer au libellé. Les requêtes sont appliquées dans l'ordre dans lequel elles sont spécifiées. |
useAdminAccess |
Définissez la valeur sur |
view |
Si cette option est spécifiée, seuls certains champs appartenant à la vue indiquée sont renvoyés. |
languageCode |
Code de langue BCP-47 à utiliser pour évaluer les libellés de champ localisés lorsque |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Réponse pour la mise à jour d'un libellé.
Représentation JSON |
---|
{ "responses": [ { object ( |
Champs | |
---|---|
responses[] |
Réponse des mises à jour. Cette mise à jour s'effectue de manière individuelle avec les mises à jour, bien que les réponses à certaines requêtes puissent être vides. |
updatedLabel |
Libellé après l'application des mises à jour. Ce champ n'est défini que si [BatchUpdateLabelResponse2.include_label_in_response] est défini sur |
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 relatif aux autorisations.
Requête
Un seul type de mise à jour à appliquer à un libellé.
Représentation JSON |
---|
{ // Union field |
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 |
Met à jour les propriétés du libellé. |
createField |
Crée un champ. |
updateField |
Met à jour les propriétés de base d'un champ. |
updateFieldType |
Mettez à jour les options de type et/ou de type de champ. |
enableField |
Active le champ. |
disableField |
Désactive le champ. |
deleteField |
Supprime un champ du libellé. |
createSelectionChoice |
Crée un choix dans un champ de sélection. |
updateSelectionChoiceProperties |
Mettez à jour les propriétés d'un choix dans un champ de sélection. |
enableSelectionChoice |
Activer un choix dans un champ de sélection |
disableSelectionChoice |
Désactiver un choix dans un champ de sélection |
deleteSelectionChoice |
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 ( |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine |
properties |
Obligatoire. Propriétés de libellé à mettre à jour. |
CreateFieldRequest
Requête de création d'un champ dans un libellé.
Représentation JSON |
---|
{
"field": {
object ( |
Champs | |
---|---|
field |
Obligatoire. Champ à créer. |
UpdateFieldPropertiesRequest
Requête de mise à jour des propriétés du champ.
Représentation JSON |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine |
id |
Obligatoire. Champ à mettre à jour. |
properties |
Obligatoire. Propriétés de base des champs. |
UpdateFieldTypeRequest
Requête de modification du type d'un champ.
Représentation JSON |
---|
{ "updateMask": string, "id": string, // Union field |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine de |
id |
Obligatoire. Champ à mettre à jour. |
Champ d'union
|
|
textOptions |
Remplacez le champ par "Texte". |
longTextOptions |
Remplacez le champ par "Texte long". |
integerOptions |
Remplacez le champ par "Integer" (Entier). |
dateOptions |
Remplacer le champ par Date. |
selectionOptions |
Remplacez le champ par "Sélection". |
userOptions |
Définissez le champ sur "Utilisateur". |
LongTextOptions
Options du champ Texte long
Représentation JSON |
---|
{ "minLength": integer, "maxLength": integer } |
Champs | |
---|---|
minLength |
Uniquement en sortie. Longueur minimale valide des valeurs du champ de texte. |
maxLength |
Uniquement en sortie. Longueur maximale valide des valeurs du champ de texte. |
EnableFieldRequest
Requête d'activation du champ.
Représentation JSON |
---|
{ "id": string } |
Champs | |
---|---|
id |
Obligatoire. ID du champ à activer. |
DisableFieldRequest
Requête de désactivation du champ.
Représentation JSON |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine |
id |
Obligatoire. Clé du champ à désactiver. |
disabledPolicy |
Obligatoire. Règle "Champ désactivé". |
DeleteFieldRequest
Requête de suppression du champ.
Représentation JSON |
---|
{ "id": string } |
Champs | |
---|---|
id |
Obligatoire. ID du champ à supprimer. |
CreateSelectionChoiceRequest
Requête de création d'un choix de sélection.
Représentation JSON |
---|
{
"fieldId": string,
"choice": {
object ( |
Champs | |
---|---|
fieldId |
Obligatoire. Champ de sélection dans lequel un choix sera créé. |
choice |
Obligatoire. Le choix à créer. |
UpdateSelectionChoicePropertiesRequest
Requête de mise à jour des propriétés d'un choix.
Représentation JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine |
fieldId |
Obligatoire. Champ de sélection à mettre à jour. |
id |
Obligatoire. Choix à mettre à jour |
properties |
Obligatoire. Propriétés de l'option "Choix" à mettre à jour. |
EnableSelectionChoiceRequest
Requête d'activation d'un choix.
Représentation JSON |
---|
{ "fieldId": string, "id": string } |
Champs | |
---|---|
fieldId |
Obligatoire. Champ de sélection dans lequel un choix sera activé. |
id |
Obligatoire. Choix d'activation. |
DisableSelectionChoiceRequest
Requête de désactivation d'un choix.
Représentation JSON |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Champs | |
---|---|
updateMask |
Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine |
fieldId |
Obligatoire. Champ de sélection dans lequel un choix sera désactivé. |
id |
Obligatoire. Choix à désactiver. |
disabledPolicy |
Obligatoire. Règle désactivée à mettre à jour. |
DeleteSelectionChoiceRequest
Requête de suppression d'un choix.
Représentation JSON |
---|
{ "fieldId": string, "id": string } |
Champs | |
---|---|
fieldId |
Obligatoire. Champ de sélection dans lequel un choix sera supprimé. |
id |
Obligatoire. Choix de suppression. |
Réponse
Réponse unique à partir d'une mise à jour.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union response . Réponse à la requête correspondante. response ne peut être qu'un des éléments suivants : |
|
updateLabel |
Mise à jour des propriétés de base d'un libellé. |
createField |
Crée un champ. |
updateField |
Met à jour les propriétés de base d'un champ. |
updateFieldType |
Mettez à jour les options de type et/ou de type de champ. |
enableField |
Active le champ. |
disableField |
Désactive le champ. |
deleteField |
Supprime un champ du libellé. |
createSelectionChoice |
Crée une option de liste de sélection à ajouter à un champ de sélection. |
updateSelectionChoiceProperties |
Met à jour un choix dans un champ de sélection. |
enableSelectionChoice |
Active un choix dans un champ de sélection. |
disableSelectionChoice |
Désactive un choix dans un champ de sélection. |
deleteSelectionChoice |
Supprime une option d'un champ de sélection. |
UpdateLabelPropertiesResponse
Réponse suite à la mise à jour des propriétés des libellés.
CreateFieldResponse
Réponse après la création d'un champ.
Représentation JSON |
---|
{ "id": string, "priority": integer } |
Champs | |
---|---|
id |
Champ du champ créé. Si aucune valeur n'est spécifiée dans une requête de création, une clé est générée automatiquement et peut être identifiée ici. |
priority |
Priorité du champ créé. La priorité peut changer de celle spécifiée pour assurer des priorités contiguës entre les champs (1-n). |
UpdateFieldPropertiesResponse
Réponse suite à la mise à jour des propriétés de champ.
Représentation JSON |
---|
{ "priority": integer } |
Champs | |
---|---|
priority |
Priorité du champ mis à jour. La priorité peut changer de celle spécifiée pour assurer des priorités contiguës entre les champs (1-n). |
UpdateFieldTypeResponse
Réponse suite à la mise à jour du type de champ.
EnableFieldResponse
Réponse après activation du champ
DisableFieldResponse
Réponse après désactivation du champ
DeleteFieldResponse
Réponse après la suppression du champ.
CreateSelectionChoiceResponse
Réponse après la création du choix de sélection.
Représentation JSON |
---|
{ "fieldId": string, "id": string } |
Champs | |
---|---|
fieldId |
ID du champ généré par le serveur. |
id |
ID généré par le serveur pour le choix créé dans le champ |
UpdateSelectionChoicePropertiesResponse
Réponse suite à la mise à jour des propriétés du choix de sélection.
Représentation JSON |
---|
{ "priority": integer } |
Champs | |
---|---|
priority |
Priorité du choix mis à jour. La priorité peut changer de celle qui a été spécifiée pour assurer des priorités contiguës entre les choix (1-n). |
EnableSelectionChoiceResponse
Réponse après activation de l'option "Choice"
DisableSelectionChoiceResponse
Réponse après désactivation de l'option "Choix".
DeleteSelectionChoiceResponse
Réponse suite à la suppression de l'option "Choice"