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
- Um projeto do Google Cloud.
- Ative o faturamento no seu projeto do Cloud. Saiba como verificar o status de faturamento dos seus projetos.
- O SDK do Cloud configurado com o projeto do Cloud.
Configurar o ambiente
Abra seu projeto do Cloud no console do Google Cloud
- No console do Google Cloud, acesse a página Selecionar um projeto.
- 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 complemento define o que o Google mostra aos usuários.
- No console do Google Cloud, acesse Menu > APIs e serviços > Tela de consentimento do OAuth.
- Em Tipo de usuário, selecione Interno e clique em Criar.
- Preencha o formulário de registro do app e clique em Salvar e continuar.
Por enquanto, você pode pular a adição de escopos e clicar em Salvar e continuar. 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 e, em seguida, adicionar os escopos de autorização necessários para o app.
- Analise o resumo do registro do app. Para fazer alterações, clique em Editar. Se o registro do app estiver correto, clique em Voltar ao painel.
Crie e implemente uma Função do Cloud
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
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" } } ] } ] } } ] } }; }
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
Encontre o e-mail da conta de serviço do complemento:
gcloud workspace-add-ons get-authorization
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
Receba o URL da função implantada. Para conseguir o URL, execute o seguinte comando e procure o campo
url
na seçãohttpsTrigger
:gcloud functions describe loadHomePage
Crie o arquivo
deployment.json
com o código de exemplo abaixo. SubstituaURL
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": {} } }
Crie a implantação:
gcloud workspace-add-ons deployments create quickstart \ --deployment-file=deployment.json
Instalar o complemento
Instale a implantação no modo de desenvolvimento:
gcloud workspace-add-ons deployments install quickstart
Abra ou recarregue o Gmail para conferir o complemento. Na barra de ferramentas à direita, procure um ícone de béquer.
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:
Desinstale o complemento da sua Conta do Google:
gcloud workspace-add-ons deployments uninstall quickstart
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: