Criar um complemento do Google Workspace com Node.js

Crie complementos do Google Workspace nas Funções do Cloud usando o ambiente de execução do Node.js.

Objetivos

  • Prepare o ambiente.
  • Crie e implante uma função do Cloud.
  • Crie e implante o complemento.
  • Instale o complemento.

Pré-requisitos

Configurar o ambiente

Abra seu projeto do Cloud no console do Google Cloud

  1. No console do Google Cloud, acesse a página Selecionar um projeto.

    Selecionar um projeto do Cloud

  2. Selecione o projeto do Google Cloud que você quer usar. Ou clique em Criar projeto e siga as instruções na tela. Se você criar um projeto do Google Cloud, talvez seja necessário ativar o faturamento dele.

Configurar a tela de permissão OAuth

Os complementos do Google Workspace exigem uma configuração de tela de consentimento. A configuração da tela de consentimento do OAuth do seu complemento define o que o Google mostra aos usuários.

  1. No console do Google Cloud, acesse Menu > > Marca.

    Acessar "Branding"

  2. Se você já tiver configurado o , poderá configurar as seguintes configurações da tela de consentimento do OAuth em Marca, Público-alvo e Acesso a dados. Se você receber a mensagem ainda não configurado, clique em Começar:
    1. Em Informações do app, em Nome do app, insira um nome para o app.
    2. Em E-mail para suporte do usuário, escolha um endereço de e-mail de suporte para que os usuários entrem em contato com você se tiverem dúvidas sobre o consentimento.
    3. Clique em Próxima.
    4. Em Público, selecione Interno.
    5. Clique em Próxima.
    6. Em Dados de contato, insira um endereço de e-mail para receber notificações sobre as mudanças no projeto.
    7. Clique em Próxima.
    8. Em Concluir, analise a Política de dados do usuário dos serviços de API do Google e, se concordar, selecione Concordo com a política de dados do usuário dos serviços de API do Google.
    9. Clique em Continuar.
    10. Clique em Criar.
  3. Por enquanto, você pode pular a adição de escopos. No futuro, quando você criar um app para uso fora da sua organização do Google Workspace, será necessário mudar o Tipo de usuário para Externo. Em seguida, adicione os escopos de autorização necessários para o app. Para saber mais, consulte o guia completo Configurar a permissão OAuth.

Crie e implemente uma Função do Cloud

  1. Em um terminal local, ative as APIs Cloud Functions, Cloud Build e Google Workspace Add-ons:

    gcloud services enable cloudfunctions cloudbuild.googleapis.com gsuiteaddons.googleapis.com
    
  2. Em um diretório vazio, crie o arquivo function.js com o seguinte exemplo de código:

    /**
     * Cloud Function that loads the homepage for a
     * Google Workspace add-on.
     *
     * @param {Object} req Request sent from Google
     * @param {Object} res Response to send back
     */
    exports.loadHomePage = function addonsHomePage (req, res) {
      res.send(createAction());
    };
    
    /** Creates a card with two widgets. */
    function createAction() {
      return {
        "action": {
          "navigations": [
            {
              "pushCard": {
                "header": {
                  "title": "Cats!"
                },
                "sections": [
                  {
                    "widgets": [
                      {
                        "textParagraph": {
                          "text": "Your random cat:"
                        }
                      },
                      {
                        "image": {
                          "imageUrl": "https://cataas.com/cat"
                         }
                      }
                    ]
                  }
                ]
              }
            }
          ]
        }
      };
    }
    
  3. Implante a função:

    gcloud functions deploy loadHomePage --runtime nodejs12 --trigger-http
    

    Se solicitado, especifique que você não permite invocações não autenticadas da função. A implantação da função pode levar alguns minutos.

Criar uma implantação de complemento

  1. Encontre o e-mail da conta de serviço do complemento:

    gcloud workspace-add-ons get-authorization
    
  2. Conceda à conta de serviço o papel cloudfunctions.invoker:

    gcloud functions add-iam-policy-binding loadHomePage \
        --role roles/cloudfunctions.invoker \
        --member serviceAccount:SERVICE_ACCOUNT_EMAIL
    
  3. Receba o URL da função implantada. Para conseguir o URL, execute o seguinte comando e procure o campo url na seção httpsTrigger:

    gcloud functions describe loadHomePage
    
  4. Crie o arquivo deployment.json com o código de exemplo a seguir. Substitua URL pelo URL da função implantada na etapa anterior.

    {
      "oauthScopes": ["https://www.googleapis.com/auth/gmail.addons.execute"],
      "addOns": {
        "common": {
          "name": "My HTTP Add-on",
          "logoUrl": "https://raw.githubusercontent.com/webdog/octicons-png/main/black/beaker.png",
          "homepageTrigger": {
            "runFunction": "URL"
          }
        },
        "gmail": {},
        "drive": {},
        "calendar": {},
        "docs": {},
        "sheets": {},
        "slides": {}
      }
    }
    
  5. Crie a implantação:

    gcloud workspace-add-ons deployments create quickstart \
        --deployment-file=deployment.json
    

Instalar o complemento

  1. Instale a implantação no modo de desenvolvimento:

    gcloud workspace-add-ons deployments install quickstart
    
  2. Abra ou recarregue o Gmail para conferir o complemento. Na barra de ferramentas à direita, procure um ícone de béquer.

  3. Clique no ícone para abrir o complemento. Se necessário, autorize o complemento.

Opcional: limpar

Para evitar cobranças na sua conta, exclua os recursos que você criou:

  1. Desinstale o complemento da sua Conta do Google:

    gcloud workspace-add-ons deployments uninstall quickstart
    
  2. Para evitar cobranças pelos recursos usados neste guia de início rápido, exclua o projeto do Cloud:

    gcloud projects delete PROJECT_ID
    

    Substitua PROJECT_ID pelo ID do projeto do Cloud que você usou para o início rápido. Encontre o ID do projeto do Cloud no console do Google Cloud na página Painel.

Próximas etapas

Para adicionar mais funcionalidades ao seu complemento do Google Workspace, consulte os seguintes guias: