Method: labels.delta

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

string

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 (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Champs
writeControl

object (WriteControl)

Permet de contrôler la manière dont les requêtes d'écriture sont exécutées.

requests[]

object (Request)

Liste des mises à jour à appliquer au libellé. Les requêtes sont appliquées dans l'ordre dans lequel elles sont spécifiées.

useAdminAccess

boolean

Définissez la valeur sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur du libellé avant d'autoriser l'accès.

view

enum (LabelView)

Si cette option est spécifiée, seuls certains champs appartenant à la vue indiquée sont 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

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 (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Champs
responses[]

object (Response)

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

object (Label)

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 true et qu'aucune erreur n'est survenue.

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 kind can be only one of the following:
  "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)
  }
  // End of list of possible types for union field kind.
}
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)

Mettez à jour les options de type et/ou de type de champ.

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ée un choix dans un champ de sélection.

updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Mettez à jour les propriétés d'un choix dans un champ de sélection.

enableSelectionChoice

object (EnableSelectionChoiceRequest)

Activer un choix dans un champ de sélection

disableSelectionChoice

object (DisableSelectionChoiceRequest)

Désactiver 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. La racine label_properties est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

properties

object (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 (Field)
  }
}
Champs
field

object (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 (Properties)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine properties est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

id

string

Obligatoire. Champ à mettre à jour.

properties

object (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 type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
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 élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

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)

Remplacez le champ par "Texte".

longTextOptions

object (LongTextOptions)

Remplacez le champ par "Texte long".

integerOptions

object (IntegerOptions)

Remplacez le champ par "Integer" (Entier).

dateOptions

object (DateOptions)

Remplacer le champ par Date.

selectionOptions

object (SelectionOptions)

Remplacez le champ par "Sélection".

userOptions

object (UserOptions)

Définissez le champ sur "Utilisateur".

LongTextOptions

Options du champ Texte long

Représentation JSON
{
  "minLength": integer,
  "maxLength": integer
}
Champs
minLength

integer

Uniquement en sortie. Longueur minimale valide des valeurs du champ de texte.

maxLength

integer

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

string

Obligatoire. ID du champ à activer.

DisableFieldRequest

Requête 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. La racine disabledPolicy est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

id

string

Obligatoire. Clé du champ à désactiver.

disabledPolicy

object (DisabledPolicy)

Obligatoire. Règle "Champ désactivé".

DeleteFieldRequest

Requête 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 à 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 (Properties)
  }
}
Champs
updateMask

string (FieldMask format)

Champs à mettre à jour. Vous devez spécifier au moins un champ. La racine properties est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

fieldId

string

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

id

string

Obligatoire. Choix à mettre à jour

properties

object (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

string

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

id

string

Obligatoire. Choix d'activation.

DisableSelectionChoiceRequest

Requête 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. La racine disabledPolicy est implicite et ne doit pas être spécifiée. Un seul élément * peut être utilisé comme raccourci pour mettre à jour chaque champ.

fieldId

string

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

id

string

Obligatoire. Choix à désactiver.

disabledPolicy

object (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

string

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

id

string

Obligatoire. Choix de suppression.

Réponse

Réponse unique à partir d'une mise à jour.

Représentation JSON
{

  // Union field response can be only one of the following:
  "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)
  }
  // End of list of possible types for union field response.
}
Champs
Champ d'union response. Réponse à la requête correspondante. response ne peut être qu'un des éléments suivants :
updateLabel

object (UpdateLabelPropertiesResponse)

Mise à jour des 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)

Mettez à jour les options de type et/ou de type de champ.

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)

Active 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 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

string

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

integer

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

integer

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

string

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

id

string

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

integer

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"