Caixas de diálogo e barras laterais nos documentos do Google Workspace

Os scripts vinculados aos arquivos do Documentos, Planilhas ou Formulários Google podem exibir vários tipos de elementos da interface do usuário, como alertas e solicitações pré-criados, além de caixas de diálogo e barras laterais com páginas personalizadas do serviço HTML. Normalmente, esses elementos são abertos usando itens de menu. Observe que, no Formulários Google, os elementos da interface do usuário ficam visíveis apenas para um editor que abre o formulário para modificá-lo, não para um usuário que abre o formulário para responder.

Caixas de diálogo de alerta

Um alerta é uma caixa de diálogo pré-criada que é aberta em um editor do Documentos, Planilhas, Apresentações ou Formulários Google. Ele exibe uma mensagem e um botão "OK". Um título e botões alternativos são opcionais. É semelhante a chamar window.alert() no JavaScript do lado do cliente em um navegador da Web.

Os alertas suspendem o script do lado do servidor enquanto a caixa de diálogo está aberta. O script será retomado após o usuário fechar a caixa de diálogo, mas as conexões JDBC não persistirem durante a suspensão.

Conforme mostrado no exemplo abaixo, o Documentos, o Formulários, o Apresentações e o Planilhas Google usam o método Ui.alert(), que está disponível em três variantes. Para substituir o botão "OK" padrão, transmita um valor do enum Ui.ButtonSet como o argumento buttons. Para avaliar em qual botão o usuário clicou, compare o valor de retorno de alert() com a enumeração Ui.Button.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show alert', 'showAlert')
      .addToUi();
}

function showAlert() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.alert(
     'Please confirm',
     'Are you sure you want to continue?',
      ui.ButtonSet.YES_NO);

  // Process the user's response.
  if (result == ui.Button.YES) {
    // User clicked "Yes".
    ui.alert('Confirmation received.');
  } else {
    // User clicked "No" or X in the title bar.
    ui.alert('Permission denied.');
  }
}

Caixas de diálogo de solicitação

Uma solicitação é uma caixa de diálogo pré-criada que é aberta em um editor do Documentos, Planilhas, Apresentações ou Formulários Google. Ele mostra uma mensagem, um campo de entrada de texto e um botão "OK". Um título e botões alternativos são opcionais. É semelhante a chamar window.prompt() no JavaScript do lado do cliente em um navegador da Web.

As solicitações suspendem o script do lado do servidor enquanto a caixa de diálogo está aberta. O script será retomado após o usuário fechar a caixa de diálogo, mas as conexões JDBC não persistirem durante a suspensão.

Conforme mostrado no exemplo abaixo, o Formulários, o Apresentações e o Planilhas Google usam o método Ui.prompt(), disponível em três variantes. Para substituir o botão "OK" padrão, transmita um valor do enum Ui.ButtonSet como o argumento buttons. Para avaliar a resposta do usuário, capture o valor de retorno para prompt(), chame PromptResponse.getResponseText() para recuperar a entrada do usuário e compare o valor de retorno para PromptResponse.getSelectedButton() com a enumeração Ui.Button.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show prompt', 'showPrompt')
      .addToUi();
}

function showPrompt() {
  var ui = SpreadsheetApp.getUi(); // Same variations.

  var result = ui.prompt(
      'Let\'s get to know each other!',
      'Please enter your name:',
      ui.ButtonSet.OK_CANCEL);

  // Process the user's response.
  var button = result.getSelectedButton();
  var text = result.getResponseText();
  if (button == ui.Button.OK) {
    // User clicked "OK".
    ui.alert('Your name is ' + text + '.');
  } else if (button == ui.Button.CANCEL) {
    // User clicked "Cancel".
    ui.alert('I didn\'t get your name.');
  } else if (button == ui.Button.CLOSE) {
    // User clicked X in the title bar.
    ui.alert('You closed the dialog.');
  }
}

Caixas de diálogo personalizadas

Uma caixa de diálogo personalizada pode exibir uma interface do usuário de serviço HTML em um editor do Documentos, Planilhas, Apresentações ou Formulários Google.

As caixas de diálogo personalizadas não suspendem o script do lado do servidor enquanto ela está aberta. O componente do lado do cliente pode fazer chamadas assíncronas para o script do lado do servidor usando a API google.script para interfaces de serviço HTML.

A caixa de diálogo pode ser fechada chamando google.script.host.close() no lado do cliente de uma interface de serviço HTML. A caixa de diálogo não pode ser fechada por outras interfaces, apenas pelo usuário ou ela mesma.

Conforme mostrado no exemplo abaixo, os apps Documentos, Formulários, Apresentações e Planilhas Google usam o método Ui.showModalDialog() para abrir a caixa de diálogo.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show dialog', 'showDialog')
      .addToUi();
}

function showDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setWidth(400)
      .setHeight(300);
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showModalDialog(html, 'My custom dialog');
}

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

Barras laterais personalizadas

Uma barra lateral pode exibir uma interface do usuário de serviço HTML em um editor do Documentos, Formulários, Apresentações ou Planilhas Google.

As barras laterais não suspendem o script do lado do servidor enquanto a caixa de diálogo está aberta. O componente do lado do cliente pode fazer chamadas assíncronas para o script do lado do servidor usando a API google.script para interfaces de serviço HTML.

A barra lateral pode ser fechada chamando google.script.host.close() no lado do cliente de uma interface de serviço HTML. A barra lateral não pode ser fechada por outras interfaces, apenas pelo usuário ou ela mesma.

Como mostrado no exemplo abaixo, os apps Documentos, Formulários, Apresentações e Planilhas Google usam o método Ui.showSidebar() para abrir a barra lateral.

function onOpen() {
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .createMenu('Custom Menu')
      .addItem('Show sidebar', 'showSidebar')
      .addToUi();
}

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Page')
      .setTitle('My custom sidebar');
  SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
      .showSidebar(html);
}

Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />

Caixas de diálogo de abertura de arquivo

O Seletor do Google é uma caixa de diálogo "Abrir arquivo" para informações armazenadas nos servidores do Google, incluindo o Google Drive, a Pesquisa de imagens Google, a Pesquisa Google de vídeos e muito mais.

Como mostrado no exemplo abaixo, a API JavaScript do lado do cliente do Picker pode ser usada no serviço HTML para criar uma caixa de diálogo personalizada que permita que os usuários selecionem arquivos existentes ou façam upload de novos arquivos e, em seguida, transmitam essa seleção de volta ao seu script para mais uso.

Para ativar o seletor e receber uma chave de API, siga estas instruções:

1. Verifique se o projeto de script está usando um projeto padrão do GCP.
2. Ative a "API Picker do Google" no projeto do GCP.
3. Enquanto seu projeto do GCP ainda estiver aberto, selecione APIs e serviços e clique em Credenciais.
4. Clique em Criar credenciais > chave de API. Essa ação cria a chave, mas ela precisa ser editada para adicionar restrições de aplicativo e de API.
5. Na caixa de diálogo da chave de API, clique em Fechar.
6. Ao lado da chave de API que você criou, clique em Mais > Editar chave de API.

7. Em Restrições de aplicativo, siga estas etapas:

   1. Selecione Referenciadores HTTP (sites da Web).
   2. Em Restrições de sites, clique em Adicionar um item.
   3. Clique em Referenciador e insira *.google.com.
   4. Adicione outro item e insira *.googleusercontent.com como referenciador.
   5. Clique em Concluído.

8. Em Restrições de API, siga estas etapas:

   1. Selecione Restringir chave.

   2. Na seção Selecionar APIs, escolha API Google Picker e clique em OK.

      Observação: a API Google Picker não aparece, a menos que você a tenha ativado porque a lista mostra apenas as APIs ativadas no projeto do Cloud.

9. Em Chave de API, clique em Copiar para a área de transferência .

10. Clique em Salvar na parte de baixo da tela.

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  try {
    SpreadsheetApp.getUi().createMenu('Picker')
        .addItem('Start', 'showPicker')
        .addToUi();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  try {
    const html = HtmlService.createHtmlOutputFromFile('dialog.html')
        .setWidth(600)
        .setHeight(425)
        .setSandboxMode(HtmlService.SandboxMode.IFRAME);
    SpreadsheetApp.getUi().showModalDialog(html, 'Select a file');
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Gets the user's OAuth 2.0 access token so that it can be passed to Picker.
 * This technique keeps Picker from needing to show its own authorization
 * dialog, but is only possible if the OAuth scope that Picker needs is
 * available in Apps Script. In this case, the function includes an unused call
 * to a DriveApp method to ensure that Apps Script requests access to all files
 * in the user's Drive.
 *
 * @return {string} The user's OAuth 2.0 access token.
 */
function getOAuthToken() {
  try {
    DriveApp.getRootFolder();
    return ScriptApp.getOAuthToken();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons.css">
  <script>
    // IMPORTANT: Replace the value for DEVELOPER_KEY with the API key obtained
    // from the Google Developers Console.
    var DEVELOPER_KEY = 'ABC123 ... ';
    var DIALOG_DIMENSIONS = {width: 600, height: 425};
    var pickerApiLoaded = false;

    /**
     * Loads the Google Picker API.
     */
    function onApiLoad() {
      gapi.load('picker', {'callback': function() {
        pickerApiLoaded = true;
      }});
     }

    /**
     * Gets the user's OAuth 2.0 access token from the server-side script so that
     * it can be passed to Picker. This technique keeps Picker from needing to
     * show its own authorization dialog, but is only possible if the OAuth scope
     * that Picker needs is available in Apps Script. Otherwise, your Picker code
     * will need to declare its own OAuth scopes.
     */
    function getOAuthToken() {
      google.script.run.withSuccessHandler(createPicker)
          .withFailureHandler(showError).getOAuthToken();
    }

    /**
     * Creates a Picker that can access the user's spreadsheets. This function
     * uses advanced options to hide the Picker's left navigation panel and
     * default title bar.
     *
     * @param {string} token An OAuth 2.0 access token that lets Picker access the
     *     file type specified in the addView call.
     */
    function createPicker(token) {
      if (pickerApiLoaded && token) {
        var picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/docs/#otherviews
            .addView(google.picker.ViewId.SPREADSHEETS)
            // Hide the navigation panel so that Picker fills more of the dialog.
            .enableFeature(google.picker.Feature.NAV_HIDDEN)
            // Hide the title bar since an Apps Script dialog already has a title.
            .hideTitleBar()
            .setOAuthToken(token)
            .setDeveloperKey(DEVELOPER_KEY)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            // Instruct Picker to fill the dialog, minus 2 pixels for the border.
            .setSize(DIALOG_DIMENSIONS.width - 2,
                DIALOG_DIMENSIONS.height - 2)
            .build();
        picker.setVisible(true);
      } else {
        showError('Unable to load the file picker.');
      }
    }

    /**
     * A callback function that extracts the chosen document's metadata from the
     * response object. For details on the response object, see
     * https://developers.google.com/picker/docs/result
     *
     * @param {object} data The response object.
     */
    function pickerCallback(data) {
      var action = data[google.picker.Response.ACTION];
      if (action == google.picker.Action.PICKED) {
        var doc = data[google.picker.Response.DOCUMENTS][0];
        var id = doc[google.picker.Document.ID];
        var url = doc[google.picker.Document.URL];
        var title = doc[google.picker.Document.NAME];
        document.getElementById('result').innerHTML =
            '<b>You chose:</b><br>Name: <a href="' + url + '">' + title +
            '</a><br>ID: ' + id;
      } else if (action == google.picker.Action.CANCEL) {
        document.getElementById('result').innerHTML = 'Picker canceled.';
      }
    }

    /**
     * Displays an error message within the #result element.
     *
     * @param {string} message The error message to display.
     */
    function showError(message) {
      document.getElementById('result').innerHTML = 'Error: ' + message;
    }
  </script>
</head>
<body>
  <div>
    <button onclick="getOAuthToken()">Select a file</button>
    <p id="result"></p>
  </div>
  <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
</body>
</html>