Method: forms.batchUpdate

Modificare il modulo con un batch 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

string

Obbligatorio. L'ID del modulo.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "includeFormInResponse": boolean,
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campi
includeFormInResponse

boolean

Indica se restituire una versione aggiornata del modello nella risposta.
requests[]

object (Request)

Obbligatorio. Le richieste di aggiornamento di questo batch.
writeControl

object (WriteControl)

Fornisce il controllo sulla 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 (Form)
  },
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campi
form

object (Form)

In base al campo della richiesta booleana includeFormInResponse, viene restituito o meno un modulo con tutte le mutazioni/gli aggiornamenti applicati. Potrebbe essere successivo all'ID revisione creato da queste modifiche.
replies[]

object (Response)

La risposta agli aggiornamenti. Questa mappatura è 1:1 con le richieste di aggiornamento, anche se le risposte ad alcune richieste potrebbero essere vuote.
writeControl

object (WriteControl)

Il controllo 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 all'autorizzazione.

Richiesta

I tipi di richieste di aggiornamento che possono essere effettuate.

Rappresentazione 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.
}
Campi
Campo unione kind. Il tipo di richiesta. kind può essere solo uno dei seguenti:
updateFormInfo

object (UpdateFormInfoRequest)

Aggiorna le informazioni del modulo.
updateSettings

object (UpdateSettingsRequest)

Aggiorna le impostazioni del modulo.
createItem

object (CreateItemRequest)

Crea un nuovo elemento.
moveItem

object (MoveItemRequest)

Spostare un elemento in una posizione specifica.
deleteItem

object (DeleteItemRequest)

Eliminare un elemento.
updateItem

object (UpdateItemRequest)

Aggiornare un articolo.

UpdateFormInfoRequest

Aggiorna le informazioni del modulo.

Rappresentazione JSON 
{
  "info": {
    object (Info)
  },
  "updateMask": string
}
Campi
info

object (Info)

Le informazioni da aggiornare.
updateMask

string (FieldMask format)

Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. È necessario specificare almeno un campo. La radice info è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per aggiornare ogni campo.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

UpdateSettingsRequest

Aggiorna FormSettings del modulo.

Rappresentazione JSON 
{
  "settings": {
    object (FormSettings)
  },
  "updateMask": string
}
Campi
settings

object (FormSettings)

Obbligatorio. Le impostazioni da aggiornare.
updateMask

string (FieldMask format)

Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. È necessario specificare almeno un campo. La radice settings è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per aggiornare ogni campo.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

CreateItemRequest

Creare un elemento in un modulo.

Rappresentazione JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  }
}
Campi
item

object (Item)

Obbligatorio. L'elemento da creare.
location

object (Location)

Obbligatorio. Dove posizionare il nuovo elemento.

Località

Una posizione specifica in un modulo.

Rappresentazione JSON 
{

  // Union field where can be only one of the following:
  "index": integer
  // End of list of possible types for union field where.
}
Campi
Campo unione where. Obbligatorio. Specifica una località nel modulo. where può essere solo uno dei seguenti:
index

integer

L'indice di un elemento nel modulo. Deve essere compreso nell'intervallo

[0..N)

, dove N è il numero di elementi nel modulo.

MoveItemRequest

Spostare un elemento in un modulo.

Rappresentazione JSON 
{
  "originalLocation": {
    object (Location)
  },
  "newLocation": {
    object (Location)
  }
}
Campi
originalLocation

object (Location)

Obbligatorio. La posizione dell'elemento da spostare.
newLocation

object (Location)

Obbligatorio. La nuova posizione dell'elemento.

DeleteItemRequest

Eliminare un elemento in un modulo.

Rappresentazione JSON 
{
  "location": {
    object (Location)
  }
}
Campi
location

object (Location)

Obbligatorio. La posizione dell'elemento da eliminare.

UpdateItemRequest

Aggiornare un elemento in un modulo.

Rappresentazione JSON 
{
  "item": {
    object (Item)
  },
  "location": {
    object (Location)
  },
  "updateMask": string
}
Campi
item

object (Item)

Obbligatorio. Nuovi valori per l'elemento. Tieni presente che gli ID articolo e domanda vengono utilizzati se sono forniti (e sono presenti nella maschera di campo). Se un ID è vuoto (e nella maschera di campo) viene generato un nuovo ID. Ciò significa che puoi modificare un elemento recuperando il modulo tramite forms.get, modificando la copia locale dell'elemento in base alle tue esigenze e utilizzando UpdateItemRequest per riscriverlo, con gli ID uguali (o non presenti nella maschera di campo).
location

object (Location)

Obbligatorio. La posizione che identifica l'elemento da aggiornare.
updateMask

string (FieldMask format)

Obbligatorio. Vengono modificati solo i valori denominati in questa maschera.

Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".

WriteControl

Fornisce il controllo sulla modalità di esecuzione delle richieste di scrittura.

Rappresentazione 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.
}
Campi
Campo unione control. Determina la revisione del modulo da cui devono essere applicate le modifiche e il comportamento della richiesta se questa revisione non è quella corrente del modulo. control può essere solo uno dei seguenti:
requiredRevisionId

string

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 viene restituito un errore di richiesta non valida (400).
targetRevisionId

string

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 in questa richiesta di aggiornamento vengono trasformate in base a queste modifiche. Il risultato è 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 viene restituito un codice 400 (errore di richiesta non valida). La richiesta può essere riprovata dopo aver letto la versione più recente del modulo. Nella maggior parte dei casi, un ID revisione target rimane valido per diversi minuti dopo la 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 kind can be only one of the following:
  "createItem": {
    object (CreateItemResponse)
  }
  // End of list of possible types for union field kind.
}
Campi
Campo unione kind. Il tipo di risposta. kind può essere solo uno dei seguenti:
createItem

object (CreateItemResponse)

Il risultato della creazione di un elemento.

CreateItemResponse

Il risultato della creazione di un elemento.

Rappresentazione JSON 
{
  "itemId": string,
  "questionId": [
    string
  ]
}
Campi
itemId

string

L'ID dell'elemento creato.
questionId[]

string

L'ID della domanda creata nell'ambito di questo elemento. Per un gruppo di domande, vengono elencati gli ID di tutte le domande create per questo elemento.