- 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
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Zone géographique
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Réponse
- CreateItemResponse
- Essayer
Modifier le formulaire avec un lot de 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 |
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 ( |
Champs | |
---|---|
includeFormInResponse |
Indique s'il faut renvoyer une version mise à jour du modèle dans la réponse. |
requests[] |
Obligatoire. Requêtes de mise à jour de ce lot. |
writeControl |
Permet de contrôler la manière dont les requêtes d'écriture sont exécutées. |
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 ( |
Champs | |
---|---|
form |
En fonction du champ de requête de valeur booléenne |
replies[] |
Réponse des mises à jour. Ce mappage fonctionne avec les requêtes de mise à jour de manière individuelle, bien que les réponses à certaines requêtes puissent être vides. |
writeControl |
Commande d'écriture mise à 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 demandes de mise à jour pouvant être effectuées.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Type de requête. kind ne peut être qu'un des éléments suivants : |
|
updateFormInfo |
Mettre à jour les informations du formulaire |
updateSettings |
Met à jour les paramètres du formulaire. |
createItem |
Créer un élément |
moveItem |
Déplacez un élément vers un emplacement spécifié. |
deleteItem |
Supprimer un élément |
updateItem |
Mettre à jour un élément |
UpdateFormInfoRequest
Mettre à jour les informations du formulaire
Représentation JSON |
---|
{
"info": {
object ( |
Champs | |
---|---|
info |
Informations à mettre à jour. |
updateMask |
Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées. Vous devez spécifier au moins un champ. La racine Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : |
UpdateSettingsRequest
Mettez à jour l'attribut FormSettings
du formulaire.
Représentation JSON |
---|
{
"settings": {
object ( |
Champs | |
---|---|
settings |
Obligatoire. Paramètres à utiliser pour la mise à jour. |
updateMask |
Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées. Vous devez spécifier au moins un champ. La racine Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : |
CreateItemRequest
Créez un élément dans un formulaire.
Représentation JSON |
---|
{ "item": { object ( |
Champs | |
---|---|
item |
Obligatoire. Élément à créer. |
location |
Obligatoire. Où placer le nouvel élément. |
Emplacement
Zone géographique spécifique dans un formulaire.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union where . Obligatoire. Spécifiez un emplacement dans le formulaire. where ne peut être qu'un des éléments suivants : |
|
index |
Index d'un élément dans le formulaire. Elle doit être comprise dans la plage
, où N correspond au nombre d'éléments dans le formulaire. |
MoveItemRequest
Déplacer un élément d'un formulaire
Représentation JSON |
---|
{ "originalLocation": { object ( |
Champs | |
---|---|
originalLocation |
Obligatoire. Emplacement de l'élément à déplacer. |
newLocation |
Obligatoire. Nouvel emplacement de l'élément. |
DeleteItemRequest
Supprimer un élément d'un formulaire.
Représentation JSON |
---|
{
"location": {
object ( |
Champs | |
---|---|
location |
Obligatoire. Emplacement de l'élément à supprimer. |
UpdateItemRequest
Mettre à jour un élément d'un formulaire
Représentation JSON |
---|
{ "item": { object ( |
Champs | |
---|---|
item |
Obligatoire. Nouvelles valeurs pour l'article. Notez que les ID d'élément et de question sont utilisés s'ils sont fournis (et qu'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 récupérant le formulaire via |
location |
Obligatoire. Emplacement identifiant l'article à mettre à jour. |
updateMask |
Obligatoire. Seules les valeurs nommées dans ce masque sont modifiées. Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : |
WriteControl
Permet de contrôler la manière dont les requêtes d'écriture sont exécutées.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union control . Détermine la révision du formulaire à partir de laquelle les modifications doivent être appliquées, ainsi que le comportement de la demande s'il ne s'agit pas de la révision actuelle du formulaire. control ne peut être qu'un des éléments suivants : |
|
requiredRevisionId |
ID de la révision du formulaire auquel la demande 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 |
ID de révision cible du formulaire auquel la demande d'écriture est appliquée. Si des modifications ont été apportées après cette révision, les modifications incluses dans cette demande de mise à jour sont prises en compte. Il en résulte 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 en conflit. 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 une erreur 400 (Erreur de requête incorrecte). Il est possible que la demande soit relancée après avoir lu la dernière version du formulaire. Dans la plupart des cas, l'ID de révision cible reste valide pendant plusieurs minutes après sa lecture, mais pour les formulaires fréquemment modifiés, cette période peut être plus courte. |
Réponse
Réponse unique à une mise à jour.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union kind . Type de réponse. kind ne peut être qu'un des éléments suivants : |
|
createItem |
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 |
ID de l'élément créé. |
questionId[] |
Identifiant 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. |