Acionar um fluxo de trabalho das Planilhas Google

As Planilhas Google são uma solução de planilhas baseada na nuvem que oferece suporte à colaboração em tempo real e ferramentas para visualizar, processar e comunicar dados.

Neste tutorial, mostramos como acionar Workflows nas Planilhas Google.

Criar um formulário para solicitar instâncias de VM

Crie um formulário que possa ser usado para enviar uma solicitação de criação de uma instância de máquina virtual (VM) do Compute Engine. Por padrão, quando você cria um formulário no app Formulários Google, ele é salvo no Google Drive.

1. Acesse forms.google.com.
2. Clique em Em branco .

   Um novo formulário é aberto.

3. Crie um formulário com cinco seções obrigatórias. O formulário vai aparecer assim:

   Ver um exemplo de formulário

   

   Nome da máquina	Texto de resposta curta
   Zona	Menu suspenso: us-central1-a us-central1-b us-central1-c us-central1-f
   Tipo	Menu suspenso: e2-micro e2-small e2-medium e2-standard-2 e2-standard-4
   Tamanho do disco (GB)	Texto de resposta curta
   Sistema operacional	Menu suspenso: debian-10 centos-stream-9 cos-93-lts cos-97-lts

4. Ative a coleta de e-mails para registrar os endereços de e-mail das pessoas que preencherem seu formulário:
   1. Clique em Configurações.
   2. Abra a seção Respostas.
   3. Clique na chave Coletar endereços de e-mail.

Vincular uma planilha ao formulário

Depois de criar um formulário, vincule uma planilha a ele para salvar as respostas nela. A planilha é salva no Drive.

1. Abra seu formulário no Forms.
2. Clique em Respostas.
3. Clique em Vincular às Planilhas.
4. Na caixa de diálogo Selecionar o destino das respostas, selecione Criar uma nova planilha.

5. Clique em Criar.

   A planilha vinculada é aberta.

6. Na coluna H, adicione um cabeçalho Aprovado?.

7. Coloque o cursor na primeira linha da coluna H e selecione Inserir > Caixa de seleção.

   A planilha vai ficar assim:

   

   Sempre que a planilha for atualizada com uma resposta, a caixa de seleção também vai aparecer na linha dessa resposta.

Ampliar as Planilhas Google usando o Apps Script

O Apps Script permite criar, ler e editar planilhas de maneira programática. A maioria dos scripts criados para as Planilhas manipula matrizes para interagir com as células, linhas e colunas de uma planilha. Para uma introdução ao uso do Apps Script com o Planilhas, consulte o Guia de início rápido de funções personalizadas.

Observação: se você estiver conectado a várias Contas do Google ao mesmo tempo, poderá ter problemas para acessar o Apps Script. Não é possível fazer login múltiplo, ou fazer login em várias Contas do Google ao mesmo tempo, no Apps Script. Para mais informações, consulte Corrigir problemas com várias Contas do Google.

1. Crie um projeto do Apps Script nas Planilhas:

   1. Abra sua planilha do Google.
   2. Selecione Extensões > Apps Script.
   3. No editor de script, clique em Projeto sem título.
   4. Dê um nome ao projeto e clique em Renomear.

   Agora, o script está vinculado à sua planilha, o que permite que ele altere a interface do usuário ou responda quando a planilha for aberta.

   Um projeto de script representa uma coleção de arquivos e recursos do Apps Script. Os arquivos de código em um projeto de script têm uma extensão .gs.

2. Você pode usar o Apps Script para escrever funções personalizadas que podem ser usadas nas Planilhas Google como uma função integrada. As funções personalizadas são criadas usando JavaScript padrão. Crie uma função:

   1. Abra seu projeto do Apps Script.
   2. Clique em Editor .
   3. Um arquivo de script aparece como um arquivo de projeto chamado Code.gs. Para editar o arquivo, selecione-o.

   4. Substitua o código no editor de script pelo seguinte, que lê os dados na sua planilha e os transmite como entrada para uma execução de fluxo de trabalho:

      const PROJECT_ID = "your-project-id";
      const REGION = "us-central1";
      const WORKFLOW = "create-vm-from-form";
      
      function handleEdit(e) {
        var range = e.range.getA1Notation();
        var sheet = e.source;
      
        if (range.length > 1 && range[0] === 'H') {
          if (e.value == "TRUE") {
            Logger.log("Approved checkbox: true");
      
            var row = range.slice(1)
            var email = sheet.getRange('B' + row).getCell(1, 1).getValue()
            var vmName = sheet.getRange('c' + row).getCell(1, 1).getValue()
            var zone = sheet.getRange('D' + row).getCell(1, 1).getValue()
            var machineType = sheet.getRange('E' + row).getCell(1, 1).getValue()
            var diskSize = sheet.getRange('F' + row).getCell(1, 1).getValue()
            var imageFamily = sheet.getRange('G' + row).getCell(1, 1).getValue()
            var imageProject = imageFamily.substring(0, imageFamily.indexOf('-')) + "-cloud"
      
            const executionPayload = {
              "argument": "{\"diskSize\": \"" + diskSize + "\", \"email\": \"" + email + "\", \"imageFamily\": \"" + imageFamily + "\", \"imageProject\": \"" + imageProject + "\", \"machineType\": \"" + machineType + "\", \"vmName\": \"" + vmName + "\", \"zone\": \"" + zone +  "\"}"
            };
      
            approve(executionPayload);
          }
          else {
            Logger.log("Approved checkbox: false");
          }
        }
      }
      
      function approve(executionPayload) {
        const headers = {
          "Authorization": "Bearer " + ScriptApp.getOAuthToken()
        };
      
        const params = {
          "method": 'post',
          "contentType": 'application/json',
          "headers": headers,
          "payload": JSON.stringify(executionPayload)
        };
      
        const url = "https://workflowexecutions.googleapis.com/v1/projects/" + PROJECT_ID + "/locations/" + REGION + "/workflows/" + WORKFLOW + "/executions";
      
        Logger.log("Workflow execution request to " + url);
        var response = UrlFetchApp.fetch(url, params);
        Logger.log(response);
      }

   5. Substitua your-project-id pelo ID do projeto Google Cloud .

      Encontre o ID do projeto na página Boas-vindas do console Google Cloud .

   6. Clique em Salvar .

3. Os acionadores instaláveis do Apps Script permitem que um projeto de script execute uma função especificada quando determinadas condições são atendidas, como quando uma planilha é aberta ou editada. Crie um gatilho:

   1. Abra seu projeto do Apps Script.
   2. Clique em Acionadores .
   3. Clique em Adicionar gatilho.
   4. Na caixa de diálogo Adicionar gatilho para YOUR_PROJECT_NAME, configure o gatilho:
      1. Na lista Escolha a função que será executada, selecione handleEdit.
      2. Na lista Escolha qual implantação deve ser executada, selecione Head.
      3. Na lista Selecionar origem do evento, escolha De planilha.
      4. Na lista Selecionar tipo de evento, escolha Ao editar.
      5. Na lista Configurações de notificação de falha, selecione Me notificar diariamente.
   5. Clique em Salvar.

   6. Se você receber uma solicitação para escolher uma Conta do Google, selecione a conta apropriada e clique em Permitir.

      Isso permite que seu projeto do Apps Script veja, edite, crie e exclua suas planilhas Google, além de se conectar a um serviço externo.

4. Um arquivo de manifesto do projeto do Apps Script é um arquivo JSON que especifica informações básicas do projeto que o Apps Script precisa para executar um script com sucesso. O editor do Apps Script oculta os arquivos de manifesto por padrão para proteger as configurações do projeto do Apps Script. Edite o arquivo de manifesto:

   1. Abra seu projeto do Apps Script.
   2. Clique em Configurações do projeto .
   3. Selecione a caixa de seleção Mostrar arquivo de manifesto "appsscript.json" no editor.
   4. Clique em Editor .
   5. O arquivo de manifesto aparece como um arquivo de projeto chamado appsscript.json. Para editar o arquivo, selecione-o.

   6. O campo oauthScopes especifica uma matriz de strings. Para definir os escopos de autorização que seu projeto usa, adicione uma matriz com os escopos que você quer oferecer suporte. Exemplo:

      {
        "timeZone": "America/Toronto",
        "dependencies": {
        },
        "exceptionLogging": "STACKDRIVER",
        "runtimeVersion": "V8",
        "oauthScopes": [
          "https://www.googleapis.com/auth/script.external_request",
          "https://www.googleapis.com/auth/cloud-platform",
          "https://www.googleapis.com/auth/spreadsheets"
        ]
      }

      Isso define escopos explícitos para:

      • Conectar a um serviço externo
      • Ver, editar, configurar e excluir seus dados do Google Cloud e conferir o endereço de e-mail da sua Conta do Google
      • Ver, editar, criar e excluir todas as suas planilhas do Planilhas Google

   7. Clique em Salvar .

   Observação: para proteger as configurações do projeto, oculte o manifesto depois de editar. Para isso, desmarque a caixa de seleção Mostrar arquivo de manifesto "appsscript.json" no editor.

Implante um fluxo de trabalho que cria uma instância de VM

Implante um fluxo de trabalho que é acionado quando uma solicitação para criar uma instância de VM é aprovada. O fluxo de trabalho chama o conector da API Compute Engine para criar uma instância de VM do Compute Engine com base nas especificações coletadas pelo formulário.

Console

1. No console Google Cloud , acesse a página Fluxos de trabalho:

   Acessar fluxos de trabalho

2. Clique em Criar.

3. Insira um nome para o novo fluxo de trabalho: create-vm-from-form.

4. Na lista Região, selecione us-central1 (Iowa).

5. Em Conta de serviço, selecione a conta de serviço padrão do Compute Engine ([e-mail]).

6. Clique em Próxima.

7. No editor de fluxo de trabalho, insira a seguinte definição:

   main:
      params: [input]
      steps:
      - init:
          assign:
               - projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
               - zone: ${input.zone}
               - machineType: ${input.machineType}
               - diskSize: ${input.diskSize}
               - imageProject: ${input.imageProject}
               - imageFamily: ${input.imageFamily}
               - vmName: ${input.vmName}
               - email: ${input.email}
      - createResource:
          call: googleapis.compute.v1.instances.insert
          args:
              project: ${projectId}
              zone: ${zone}
              body:
                  name: ${vmName}
                  machineType: ${"projects/" + projectId + "/zones/" + zone + "/machineTypes/" + machineType}
                  disks:
                   - initializeParams:
                       diskSizeGb: ${diskSize}
                       sourceImage: ${"projects/" + imageProject + "/global/images/family/" + imageFamily}
                     type: PERSISTENT
                     boot: true
                     autoDelete: true
                  networkInterfaces:
                   - network: "global/networks/default"
          result: insertResult
      - retStep:
          return: ${insertResult}

8. Clique em Implantar.

gcloud

1. Crie um arquivo de código-fonte para seu fluxo de trabalho:

   touch create-vm-from-form.yaml

2. Em um editor de texto, copie o seguinte fluxo de trabalho para o arquivo de código-fonte:

   main:
      params: [input]
      steps:
      - init:
          assign:
               - projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
               - zone: ${input.zone}
               - machineType: ${input.machineType}
               - diskSize: ${input.diskSize}
               - imageProject: ${input.imageProject}
               - imageFamily: ${input.imageFamily}
               - vmName: ${input.vmName}
               - email: ${input.email}
      - createResource:
          call: googleapis.compute.v1.instances.insert
          args:
              project: ${projectId}
              zone: ${zone}
              body:
                  name: ${vmName}
                  machineType: ${"projects/" + projectId + "/zones/" + zone + "/machineTypes/" + machineType}
                  disks:
                   - initializeParams:
                       diskSizeGb: ${diskSize}
                       sourceImage: ${"projects/" + imageProject + "/global/images/family/" + imageFamily}
                     type: PERSISTENT
                     boot: true
                     autoDelete: true
                  networkInterfaces:
                   - network: "global/networks/default"
          result: insertResult
      - retStep:
          return: ${insertResult}

3. Implante o fluxo de trabalho digitando o seguinte comando:

   gcloud workflows deploy create-vm-from-form \
       --source=create-vm-from-form.yaml \
       --location=us-central1 \
       --service-account=[e-mail]

   Substitua PROJECT_NUMBER pelo número do seu projeto Google Cloud. Para recuperar o número do projeto:

   gcloud projects describe PROJECT_ID

Testar o fluxo completo

Para confirmar que tudo está funcionando como esperado, tente executar todo o processo.

1. Envie o formulário para você mesmo e responda às perguntas adequadamente.

   Verifique se as especificações usadas para criar uma instância de VM são válidas. Caso contrário, a execução do fluxo de trabalho vai falhar. Para mais informações, consulte Família de máquinas de uso geral do Compute Engine.

2. Para enviar sua resposta, clique em Enviar.

3. Abra seu formulário no Forms.

4. Clique em Respostas.

5. Clique em Ver nas Planilhas.

   A planilha vinculada é aberta.

6. Na linha da sua resposta, marque a caixa de seleção Aprovado?.

7. Abra seu projeto do Apps Script.

8. Clique em Execuções .

   O gatilho precisa ser executado e listado com o status Completed.

9. Confirme se o fluxo de trabalho create-vm-from-form foi concluído com sucesso:

   Console

   1. No console Google Cloud , acesse a página Fluxos de trabalho.

      Acessar fluxos de trabalho

   2. Na página Fluxos de trabalho, clique no fluxo de trabalho create-vm-from-form para acessar a página de detalhes dele.

   3. Na página Detalhes do fluxo de trabalho, para recuperar os detalhes de uma execução específica, clique no ID de execução adequado.

      O Estado da execução deve ser Concluído e, no painel "Entrada", as especificações da VM solicitada vão aparecer.

   gcloud

   Recupere uma lista das tentativas de execução do fluxo de trabalho:

   gcloud workflows executions list create-vm-from-form

   O resultado será semelhante a este:

   NAME: projects/918619793306/locations/us-central1/workflows/create-vm-from-form/executions/d8947ecb-9ccb-4ea1-ba10-e5c10414e3be
   STATE: SUCCEEDED
   START_TIME: 2023-01-24T15:07:40.404741791Z
   END_TIME: 2023-01-24T15:07:55.649373625Z

10. Confirme se uma nova VM foi criada conforme o esperado:

    Console

    No console do Google Cloud , acesse a página Instâncias de VM.

    Acessar instâncias de VM

    A instância de VM vai aparecer com um status indicando que ela está em execução.

    gcloud

    Recupere uma lista agregada de todas as VMs em todas as zonas de um projeto:

    gcloud compute instances list

    A instância de VM vai aparecer com um status indicando que ela está em execução.

    Para mais informações sobre o comando gcloud compute instances list, consulte a página de referência.