- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Solicitação
- UpdateFormInfoRequest
- UpdateSettingsRequest
- CreateItemRequest
- Local
- MoveItemRequest
- DeleteItemRequest
- UpdateItemRequest
- WriteControl
- Resposta
- CreateItemResponse
- Faça um teste
Altere o formulário com um lote de atualizações.
Solicitação HTTP
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros | |
---|---|
formId |
Obrigatório. O ID do formulário. |
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Campos | |
---|---|
includeFormInResponse |
Define se uma versão atualizada do modelo será retornada na resposta. |
requests[] |
Obrigatório. As solicitações de atualização deste lote. |
writeControl |
Fornece controle sobre como as solicitações de gravação são executadas. |
Corpo da resposta
Resposta a um BatchUpdateFormRequest.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "form": { object ( |
Campos | |
---|---|
form |
Com base no campo de solicitação booleana |
replies[] |
A resposta das atualizações. Isso é mapeado individualmente com as solicitações de atualização, embora as respostas a algumas possam estar vazias. |
writeControl |
O controle de gravação atualizado após a aplicação da solicitação. |
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/forms.body
Para mais informações, consulte o Guia de autorização.
Solicitação
Os tipos de solicitações de atualização que podem ser feitas.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de solicitação. kind pode ser apenas de um dos tipos a seguir: |
|
updateFormInfo |
Atualize as informações do formulário. |
updateSettings |
Atualiza as configurações do formulário. |
createItem |
Cria um novo item. |
moveItem |
Mova um item para um local específico. |
deleteItem |
Excluir um item |
updateItem |
Atualizar um item. |
UpdateFormInfoRequest
Atualize as informações do formulário.
Representação JSON |
---|
{
"info": {
object ( |
Campos | |
---|---|
info |
As informações a serem atualizadas. |
updateMask |
Obrigatório. Somente valores nomeados nessa máscara são alterados. É necessário especificar pelo menos um campo. A raiz É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
UpdateSettingsRequest
Atualize o FormSettings
do formulário.
Representação JSON |
---|
{
"settings": {
object ( |
Campos | |
---|---|
settings |
Obrigatório. As configurações a serem atualizadas. |
updateMask |
Obrigatório. Somente valores nomeados nessa máscara são alterados. É necessário especificar pelo menos um campo. A raiz É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
CreateItemRequest
Crie um item em um formulário.
Representação JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Obrigatório. Item a ser criado. |
location |
Obrigatório. Onde colocar o novo item. |
Local
Um local específico em um formulário.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união where . Obrigatório. Especifique um local no formulário. where pode ser apenas de um dos tipos a seguir: |
|
index |
O índice de um item no formato. Precisa estar no intervalo
, em que N é o número de itens no formulário. |
MoveItemRequest
Mover um item em um formulário.
Representação JSON |
---|
{ "originalLocation": { object ( |
Campos | |
---|---|
originalLocation |
Obrigatório. Local do item que será movido. |
newLocation |
Obrigatório. O novo local do item. |
DeleteItemRequest
Excluir um item de um formulário.
Representação JSON |
---|
{
"location": {
object ( |
Campos | |
---|---|
location |
Obrigatório. Local do item a ser excluído. |
UpdateItemRequest
Atualizar um item em um formulário.
Representação JSON |
---|
{ "item": { object ( |
Campos | |
---|---|
item |
Obrigatório. Novos valores para o item. Os IDs do item e da pergunta serão usados se forem fornecidos e estiverem na máscara de campo. Se um ID estiver em branco (e na máscara de campo), um novo ID será gerado. Isso significa que você pode modificar um item recebendo o formulário por |
location |
Obrigatório. Local que identifica o item a ser atualizado. |
updateMask |
Obrigatório. Somente valores nomeados nessa máscara são alterados. É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: |
WriteControl
Fornece controle sobre como as solicitações de gravação são executadas.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união control . Determina a revisão do formulário a partir do qual as alterações devem ser aplicadas e como a solicitação deverá se comportar se essa revisão não for a revisão atual do formulário. control pode ser apenas de um dos tipos a seguir: |
|
requiredRevisionId |
O ID da revisão do formulário ao qual a solicitação de gravação é aplicada. Se esta não for a revisão mais recente do formulário, a solicitação não será processada e retornará um erro de solicitação 400 inválida. |
targetRevisionId |
O ID da revisão de destino do formulário ao qual a solicitação de gravação é aplicada. Se ocorreram alterações após essa revisão, as alterações na solicitação de atualização serão transformadas em relação a essas alterações. Isso resulta em uma nova revisão do formulário que incorpora as alterações na solicitação e as alterações intermediárias, com o servidor resolvendo as alterações conflitantes. O ID da revisão de destino só pode ser usado para gravar em versões recentes de um formulário. Se a revisão de destino estiver muito atrasada em relação à revisão mais recente, a solicitação não será processada e retornará um erro 400 (Erro de solicitação inválida). A solicitação poderá ser repetida após a leitura da versão mais recente do formulário. Na maioria dos casos, um ID de revisão de destino permanece válido por vários minutos após a leitura. No entanto, para formulários editados com frequência, essa janela pode ser menor. |
Resposta
Uma única resposta de uma atualização.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união kind . O tipo de resposta. kind pode ser apenas de um dos tipos a seguir: |
|
createItem |
O resultado da criação de um item. |
CreateItemResponse
O resultado da criação de um item.
Representação JSON |
---|
{ "itemId": string, "questionId": [ string ] } |
Campos | |
---|---|
itemId |
ID do item criado. |
questionId[] |
O ID da pergunta criada como parte do item. Para um grupo de perguntas, ele lista os IDs de todas as perguntas criadas para o item. |