- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiedi
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Località
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Risposta
- CreateItemResponse
- Prova!
Modifica il modulo con un gruppo di aggiornamenti.
Richiesta HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
formId |
Obbligatorio. L'ID modulo. |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Campi | |
---|---|
includeFormInResponse |
Indica se restituire o meno una versione aggiornata del modello nella risposta. |
requests[] |
Obbligatorio. Le richieste di aggiornamento del batch. |
writeControl |
Fornisce il controllo sulle modalità di esecuzione delle richieste di scrittura. |
Corpo della risposta
Risposta a un BatchUpdateFormRequest.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "form": { object ( |
Campi | |
---|---|
form |
In base al campo di richiesta bool |
replies[] |
La risposta degli aggiornamenti. Ciò consente di mappare 1:1 con le richieste di aggiornamento, anche se le risposte ad alcune richieste potrebbero essere vuote. |
writeControl |
Il controllo di scrittura aggiornato dopo l'applicazione della richiesta. |
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/forms.body
Per ulteriori informazioni, consulta la Guida alle autorizzazioni.
Richiesta
I tipi di richieste di aggiornamento che è possibile effettuare.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione kind . Il tipo di richiesta. kind può essere solo uno dei seguenti: |
|
updateFormInfo |
Aggiorna le informazioni del modulo. |
updateSettings |
Consente di aggiornare le impostazioni del modulo. |
createItem |
Crea un nuovo elemento. |
moveItem |
Sposta un elemento in una posizione specificata. |
deleteItem |
Eliminare un elemento. |
updateItem |
Aggiorna un elemento. |
UpdateFormInfoRequest
Aggiorna le informazioni del modulo.
Rappresentazione JSON |
---|
{
"info": {
object ( |
Campi | |
---|---|
info |
Le informazioni da aggiornare. |
updateMask |
Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. È necessario specificare almeno un campo. La radice Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: |
UpdateSettingsRequest
Aggiorna FormSettings
del modulo.
Rappresentazione JSON |
---|
{
"settings": {
object ( |
Campi | |
---|---|
settings |
Obbligatorio. Le impostazioni con cui eseguire l'aggiornamento. |
updateMask |
Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. È necessario specificare almeno un campo. La radice Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: |
CreateItemRequest
Crea un elemento in un modulo.
Rappresentazione JSON |
---|
{ "item": { object ( |
Campi | |
---|---|
item |
Obbligatorio. L'elemento da creare. |
location |
Obbligatorio. Dove posizionare il nuovo elemento. |
Località
Una posizione specifica in un modulo.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione where . Obbligatorio. Specifica una località nel modulo. where può essere solo uno dei seguenti: |
|
index |
L'indice di un elemento del modulo. Deve essere compreso nell'intervallo
, dove N è il numero di elementi nel modulo. |
MoveItemRequest
Spostare un elemento in un modulo.
Rappresentazione JSON |
---|
{ "originalLocation": { object ( |
Campi | |
---|---|
originalLocation |
Obbligatorio. La posizione dell'elemento da spostare. |
newLocation |
Obbligatorio. La nuova posizione dell'elemento. |
DeleteItemRequest
Eliminare un elemento in un modulo.
Rappresentazione JSON |
---|
{
"location": {
object ( |
Campi | |
---|---|
location |
Obbligatorio. La posizione dell'elemento da eliminare. |
UpdateItemRequest
Aggiornare un elemento in un modulo.
Rappresentazione JSON |
---|
{ "item": { object ( |
Campi | |
---|---|
item |
Obbligatorio. Nuovi valori per l'elemento. Tieni presente che gli ID elemento e domanda vengono utilizzati se sono forniti (e si trovano nella maschera del campo). Se un ID è vuoto (e nella maschera del campo), viene generato un nuovo ID. Ciò significa che puoi modificare un elemento recuperando il modulo tramite |
location |
Obbligatorio. La località che identifica l'articolo da aggiornare. |
updateMask |
Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: |
WriteControl
Fornisce il controllo sulle modalità di esecuzione delle richieste di scrittura.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione control . Determina la revisione del modulo a cui applicare le modifiche e il comportamento della richiesta se questa non è la revisione corrente del modulo. control può essere solo uno dei seguenti: |
|
requiredRevisionId |
L'ID revisione del modulo a cui viene applicata la richiesta di scrittura. Se non si tratta dell'ultima revisione del modulo, la richiesta non viene elaborata e restituisce un errore 400 di richiesta errata. |
targetRevisionId |
L'ID revisione di destinazione del modulo a cui viene applicata la richiesta di scrittura. Se sono state apportate modifiche dopo questa revisione, le modifiche nella richiesta di aggiornamento vengono trasformate in base a queste modifiche. Ciò determina una nuova revisione del modulo che incorpora sia le modifiche nella richiesta sia quelle intermedie, con il server che risolve le modifiche in conflitto. L'ID revisione di destinazione può essere utilizzato solo per scrivere nelle versioni recenti di un modulo. Se la revisione di destinazione è troppo indietro rispetto all'ultima revisione, la richiesta non viene elaborata e restituisce un errore 400 (errore di richiesta non valido). Dopo aver letto l'ultima versione del modulo, è possibile riprovare la richiesta. Nella maggior parte dei casi un ID revisione di destinazione rimane valido per diversi minuti dopo la sua lettura, ma per i moduli modificati di frequente questa finestra potrebbe essere più breve. |
Risposta
Una singola risposta da un aggiornamento.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo di unione kind . Il tipo di risposta. kind può essere solo uno dei seguenti: |
|
createItem |
Il risultato della creazione di un elemento. |
CreateItemResponse
Il risultato della creazione di un elemento.
Rappresentazione JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
Campi | |
---|---|
itemId |
L'ID dell'elemento creato. |
questionId[] |
L'ID della domanda creata come parte di questo elemento. Per un gruppo di domande, elenca gli ID di tutte le domande create per questo elemento. |