Method: forms.setPublishSettings

Atualiza as configurações de publicação de um formulário.

Não há suporte para formulários legados porque eles não têm o campo publishSettings.

Solicitação HTTP

POST https://forms.googleapis.com/v1/forms/{formId}:setPublishSettings

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
formId

string

Obrigatório. O ID do formulário. Você pode receber o ID do campo Form.form_id.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "publishSettings": {
    object (PublishSettings)
  },
  "updateMask": string
}
Campos
publishSettings

object (PublishSettings)

Obrigatório. As configurações de publicação desejadas para o formulário.
updateMask

string (FieldMask format)

Opcional. Os campos publishSettings a serem atualizados. Essa máscara de campo aceita os seguintes valores:

  • publishState: atualiza ou substitui todas as configurações de publishState.
  • "*": atualiza ou substitui todos os campos publishSettings.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da resposta

A resposta de uma solicitação forms.setPublishSettings.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "formId": string,
  "publishSettings": {
    object (PublishSettings)
  }
}
Campos
formId

string

Obrigatório. O ID do formulário. É o mesmo que o campo Form.form_id.
publishSettings

object (PublishSettings)

As configurações de publicação do formulário.

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.