Method: forms.batchUpdate

Cambia 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

string

Obbligatorio. L'ID 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)

Consente di controllare il modo in cui vengono eseguite le richieste di scrittura.

Corpo della risposta

Risposta a una 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 di richiesta bool includeFormInResponse, viene restituito o meno un modulo con tutte le mutazioni/aggiornamenti applicati. Potrebbe essere successivo all'ID revisione creato da queste modifiche.
replies[]

object (Response)

La risposta degli aggiornamenti. Mappa 1:1 con le richieste di aggiornamento, anche se le risposte ad alcune richieste potrebbero essere vuote.
writeControl

object (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 all'autorizzazione.

Richiesta

I tipi di richieste di aggiornamento che è possibile effettuare.

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 i dati del modulo.
updateSettings

object (UpdateSettingsRequest)

Aggiorna le impostazioni del modulo.
createItem

object (CreateItemRequest)

Crea un nuovo elemento.
moveItem

object (MoveItemRequest)

Sposta un elemento in una posizione specificata.
deleteItem

object (DeleteItemRequest)

Eliminare un elemento.
updateItem

object (UpdateItemRequest)

Aggiorna un elemento.

UpdateFormInfoRequest

Aggiorna i dati 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. Il valore principale info è implicito e non deve essere specificato. Un singolo "*" può essere utilizzato come forma breve per aggiornare ogni campo.

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

UpdateSettingsRequest

Aggiorna FormSettings del modulo.

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

object (FormSettings)

Obbligatorio. Le impostazioni da utilizzare per l'aggiornamento.
updateMask

string (FieldMask format)

Obbligatorio. Vengono modificati solo i valori denominati in questa maschera. È necessario specificare almeno un campo. Il valore principale settings è implicito e non deve essere specificato. Un singolo "*" può essere utilizzato come forma breve per aggiornare ogni campo.

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

CreateItemRequest

Crea 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 rientrare 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 di 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 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 scaricando il modulo tramite forms.get, modificando la copia locale dell'elemento come vuoi e utilizzando UpdateItemRequest per riscriverlo, con gli ID uguali (o meno nella maschera del 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 di nomi completi dei campi separati da virgole. Esempio: "user.displayName,photo".

WriteControl

Consente di controllare il modo in cui vengono eseguite le 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 a cui applicare le modifiche e il comportamento della richiesta se non è la revisione 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 restituisce un errore 400 di richiesta errata.
targetRevisionId

string

L'ID revisione target 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. Ciò porta a una nuova revisione del modulo che incorpora sia le modifiche nella richiesta sia le modifiche 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 target è troppo indietro rispetto all'ultima revisione, la richiesta non viene elaborata e restituisce un errore 400 (Errore di richiesta non valida). È possibile ritentare la richiesta dopo aver letto l'ultima versione del modulo. Nella maggior parte dei casi un ID revisione di destinazione rimane valido per diversi minuti dopo la lettura, ma per i moduli modificati di frequente questa finestra può essere più breve.

Risposta

Una singola risposta a 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 come parte di questo elemento; per un gruppo di domande elenca gli ID di tutte le domande create per questo elemento.