Method: forms.batchUpdate

Modifiez le formulaire avec plusieurs mises à jour.

Requête HTTP

POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
formId

string

Obligatoire. ID du formulaire.

Corps de la requête

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

Représentation JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Champs
includeFormInResponse

boolean

Indique si une version mise à jour du modèle doit être renvoyée dans la réponse.
requests[]

object (Request)

Obligatoire. Requêtes de mise à jour de ce lot.
writeControl

object (WriteControl)

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

Corps de la réponse

Réponse à une BatchUpdateFormRequest.

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

Représentation JSON 
{
  "form": {
    object (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Champs
form

object (Form)

En fonction du champ de requête booléenne includeFormInResponse, un formulaire contenant toutes les mutations/mises à jour appliquées est renvoyé ou non. Il peut être ultérieur à l'ID de révision créé par ces modifications.
replies[]

object (Response)

Réponse aux mises à jour. Ce mappage correspond exactement aux demandes de mise à jour, bien que les réponses à certaines demandes puissent être vides.
writeControl

object (WriteControl)

Contrôle d'écriture mis à jour après l'application de la requête.

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/forms.body

Pour en savoir plus, consultez le Guide relatif aux autorisations.

Requête

Types de requêtes de mise à jour pouvant être effectuées.

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "updateFormInfo": {
    object (UpdateFormInfoRequest)
  },
  "updateSettings": {
    object (UpdateSettingsRequest)
  },
  "createItem": {
    object (CreateItemRequest)
  },
  "moveItem": {
    object (MoveItemRequest)
  },
  "deleteItem": {
    object (DeleteItemRequest)
  },
  "updateItem": {
    object (UpdateItemRequest)
  }
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type de requête. kind ne peut être qu'un des éléments suivants :
updateFormInfo

object (UpdateFormInfoRequest)

Mettez à jour les informations du formulaire.
updateSettings

object (UpdateSettingsRequest)

Met à jour les paramètres du formulaire.
createItem

object (CreateItemRequest)

Créer un élément.
moveItem

object (MoveItemRequest)

Déplacer un élément vers un emplacement spécifié
deleteItem

object (DeleteItemRequest)

Supprimer un élément
updateItem

object (UpdateItemRequest)

Mettre à jour un élément

UpdateFormInfoRequest

Mettez à jour les informations du formulaire.

Représentation JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Champs
info

object (Info)

Informations à mettre à jour.
updateMask

string (FieldMask format)

Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées. Vous devez spécifier au moins un champ. La racine info est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour mettre à jour chaque champ.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

UpdateSettingsRequest

Mettez à jour l'élément FormSettings du formulaire.

Représentation JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Champs
settings

object (FormSettings)

Obligatoire. Paramètres à utiliser pour la mise à jour.
updateMask

string (FieldMask format)

Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées. Vous devez spécifier au moins un champ. La racine settings est implicite et ne doit pas être spécifiée. Un seul "*" peut être utilisé comme raccourci pour mettre à jour chaque champ.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

CreateItemRequest

Créez un élément dans un formulaire.

Représentation JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Champs
item

object (Item)

Obligatoire. Élément à créer.
location

object (Location)

Obligatoire. Où placer le nouvel élément.

Lieu

un emplacement spécifique dans un formulaire ;

Représentation JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Champs
Champ d'union where. Obligatoire. Spécifiez un emplacement dans le formulaire. where ne peut être qu'un des éléments suivants :
index

integer

Index d'un élément sous la forme. Cette valeur doit être comprise dans la plage

[0..N)

, où N correspond au nombre d'éléments dans le formulaire.

MoveItemRequest

Déplacer un élément dans un formulaire

Représentation JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Champs
originalLocation

object (Location)

Obligatoire. Emplacement de l'élément à déplacer.
newLocation

object (Location)

Obligatoire. Nouvel emplacement de l'élément.

DeleteItemRequest

Supprimer un élément d'un formulaire

Représentation JSON 
{
  "location": {
    object (Location)
  }
}
Champs
location

object (Location)

Obligatoire. Emplacement de l'élément à supprimer.

UpdateItemRequest

Mettre à jour un élément dans un formulaire

Représentation JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Champs
item

object (Item)

Obligatoire. Nouvelles valeurs pour l'élément. Notez que les ID d'élément et de question sont utilisés s'ils sont fournis (et s'ils se trouvent dans le masque de champ). Si un ID est vide (et dans le masque de champ), un nouvel ID est généré. Cela signifie que vous pouvez modifier un élément en obtenant le formulaire via forms.get, en modifiant votre copie locale de cet élément comme vous le souhaitez et en utilisant UpdateItemRequest pour le réécrire, avec les mêmes ID (ou non dans le masque de champ).
location

object (Location)

Obligatoire. Emplacement identifiant l'élément à mettre à jour.
updateMask

string (FieldMask format)

Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"

WriteControl

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

Représentation JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Champs
Champ d'union control. Détermine la révision du formulaire à partir de laquelle les modifications doivent être appliquées et le comportement de la requête si cette révision n'est pas la révision actuelle du formulaire. control ne peut être qu'un des éléments suivants :
requiredRevisionId

string

ID de révision du formulaire auquel la requête d'écriture est appliquée. S'il ne s'agit pas de la dernière révision du formulaire, la requête n'est pas traitée et renvoie une erreur 400 (requête incorrecte).
targetRevisionId

string

ID de révision cible du formulaire auquel la requête d'écriture est appliquée.

Si des modifications ont eu lieu après cette révision, les modifications de cette demande de mise à jour sont transformées en conséquence. Cela entraîne une nouvelle révision du formulaire qui intègre à la fois les modifications apportées à la demande et les modifications intermédiaires, le serveur résolvant les modifications conflictuelles.

L'ID de révision cible ne peut être utilisé que pour écrire dans les versions récentes d'un formulaire. Si la révision cible est trop éloignée de la dernière révision, la requête n'est pas traitée et renvoie un code 400 (erreur de requête incorrecte). La requête peut faire l'objet d'une nouvelle tentative après avoir lu la dernière version du formulaire. Dans la plupart des cas, un ID de révision cible reste valide plusieurs minutes après sa lecture, mais cette fenêtre peut être plus courte pour les formulaires fréquemment modifiés.

Réponse

Une seule réponse à partir d'une mise à jour.

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type de réponse. kind ne peut être qu'un des éléments suivants :
createItem

object (CreateItemResponse)

Résultat de la création d'un élément.

CreateItemResponse

Résultat de la création d'un élément.

Représentation JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Champs
itemId

string

Identifiant de l'élément créé.
questionId[]

string

ID de la question créée pour cet élément. Pour un groupe de questions, il répertorie les ID de toutes les questions créées pour cet élément.