Class Browser

Navegador

Essa classe fornece acesso a caixas de diálogo específicas do Google Planilhas.

Os métodos dessa classe só podem ser usados no contexto de uma planilha Google. Use as caixas de diálogo do Google Workspace.

Consulte também

Propriedades

PropriedadeTipoDescrição
ButtonsButtonSet

Métodos

MétodoTipo de retornoBreve descrição
inputBox(prompt)String|nullAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(prompt, buttons)String|nullAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(title, prompt, buttons)String|nullAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
msgBox(prompt)String|nullMostra uma caixa de diálogo com a mensagem especificada e um botão "OK" no navegador do usuário.
msgBox(prompt, buttons)String|nullMostra uma caixa de diálogo com a mensagem e os botões especificados no navegador do usuário.
msgBox(title, prompt, buttons)String|nullAbre uma caixa de diálogo com o título, a mensagem e os botões especificados no navegador do usuário.

Documentação detalhada

inputBox(prompt)

Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.

O método inputBox gera uma caixa de entrada do lado do cliente que mostra o comando especificado ao usuário. Essa função suspende o script do lado do servidor. Ele é retomado automaticamente depois que o usuário fecha a caixa de diálogo, mas as conexões JDBC não persistem durante a suspensão. 

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox('Enter your name');
 Esse método não é recomendado. Em vez disso, use um comando da interface.

Parâmetros

NomeTipoDescrição
promptStringO texto a ser exibido na caixa de diálogo.

Retornar

String|null: o texto inserido pelo usuário ou "cancelar" para uma caixa de diálogo cancelada ou dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

inputBox(prompt, buttons)

Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.

O método "inputBox" gera uma caixa de entrada do lado do cliente que mostra o comando ao usuário e oferece uma opção de botões a serem exibidos. Essa função faz com que o script do lado do servidor seja suspenso. Ele é retomado automaticamente depois que o usuário fecha a caixa de diálogo, mas as conexões JDBC não são mantidas durante a suspensão. 

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox('Enter your name', Browser.Buttons.OK_CANCEL);
 Esse método não é recomendado. Em vez disso, use um comando da interface.

Parâmetros

NomeTipoDescrição
promptStringO texto a ser exibido na caixa de diálogo.
buttonsButtonSetO tipo de conjunto de botões a ser usado.

Retornar

String|null: o texto inserido pelo usuário ou "cancelar" para uma caixa de diálogo cancelada ou dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

inputBox(title, prompt, buttons)

Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.

O método inputBox gera uma caixa de entrada do lado do cliente com o título especificado, que mostra o comando especificado ao usuário e oferece uma opção de botões a serem exibidos. Essa função faz com que o script do lado do servidor seja suspenso. Ela é retomada automaticamente depois que o usuário limpa a caixa de diálogo, mas as conexões JDBC não persistem durante a suspensão. 

// The code below sets the value of name to the name input by the user, or
// 'cancel'.
const name = Browser.inputBox(
    'ID Check',
    'Enter your name',
    Browser.Buttons.OK_CANCEL,
);
 Esse método não é recomendado. Em vez disso, use um comando da interface.

Parâmetros

NomeTipoDescrição
titleStringO título da caixa de diálogo.
promptStringO texto a ser exibido na caixa de diálogo.
buttonsButtonSetO tipo de conjunto de botões a ser usado.

Retornar

String|null: o texto inserido pelo usuário ou "cancelar" para uma caixa de diálogo cancelada ou dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(prompt)

Mostra uma caixa de diálogo com a mensagem especificada e um botão "OK" no navegador do usuário.

O método msgBox gera uma caixa de mensagem do lado do cliente que mostra a mensagem especificada ao usuário. Esse método suspende o script do lado do servidor. Ele é retomado automaticamente depois que o usuário fecha a caixa de diálogo, mas as conexões JDBC não persistem durante a suspensão. 

// The code below displays "hello world" in a dialog box with an OK button
Browser.msgBox('hello world');
 Esse método não é recomendado. Em vez disso, use uma caixa de diálogo de alerta da interface.

Parâmetros

NomeTipoDescrição
promptStringO texto a ser exibido na caixa de diálogo.

Retornar

String|null: o texto em letras minúsculas do botão clicado pelo usuário ou "cancelar" para uma caixa de diálogo dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(prompt, buttons)

Mostra uma caixa de diálogo com a mensagem e os botões especificados no navegador do usuário.

O método msgBox gera uma caixa de mensagem do lado do cliente que mostra a mensagem especificada ao usuário e oferece uma opção de botões para exibição. Esse método suspende o script do lado do servidor. Ele é retomado automaticamente depois que o usuário fecha a caixa de diálogo, mas as conexões JDBC não são mantidas durante a suspensão. 

// The code below displays "hello world" in a dialog box with OK and Cancel
// buttons.
Browser.msgBox('hello world', Browser.Buttons.OK_CANCEL);
 Esse método não é recomendado. Em vez disso, use uma caixa de diálogo de alerta da interface.

Parâmetros

NomeTipoDescrição
promptStringO texto a ser exibido na caixa de diálogo.
buttonsButtonSetO tipo de conjunto de botões a ser usado.

Retornar

String|null: o texto em letras minúsculas do botão clicado pelo usuário ou "cancelar" para uma caixa de diálogo dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

msgBox(title, prompt, buttons)

Abre uma caixa de diálogo com o título, a mensagem e os botões especificados no navegador do usuário.

O método msgBox gera uma caixa de mensagem do lado do cliente com o título especificado, que mostra a mensagem ao usuário e oferece uma opção de botões a serem exibidos. Esse método suspende o script do lado do servidor. Ela é retomada automaticamente depois que o usuário limpa a caixa de diálogo, mas as conexões JDBC não persistem durante a suspensão. 

// The code below displays "hello world" in a dialog box with a custom title and
// Yes and No buttons
Browser.msgBox('Greetings', 'hello world', Browser.Buttons.YES_NO);
 Esse método não é recomendado. Em vez disso, use uma caixa de diálogo de alerta da interface.

Parâmetros

NomeTipoDescrição
titleStringO título da caixa de diálogo.
promptStringO texto a ser exibido na caixa de diálogo.
buttonsButtonSetO tipo de conjunto de botões a ser usado.

Retornar

String|null: o texto em letras minúsculas do botão clicado pelo usuário ou "cancelar" para uma caixa de diálogo dispensada.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets