Criar um guia de início rápido do complemento do Google Workspace

Crie complementos do Google Workspace no Cloud Functions usando o ambiente de execução do Node.js.

Objetivos

Configurar o ambiente.
Criar e implantar uma função do Cloud
Crie e implante o complemento.
Instale o complemento.

Pré-requisitos

Um projeto do Google Cloud.
Ative o faturamento do seu projeto do Cloud. Aprenda a verificar o status de faturamento dos seus projetos.
O SDK Cloud configurado com o projeto do Cloud.

Configurar o ambiente

Abrir seu projeto do Cloud no console do Google Cloud

No console do Google Cloud, acesse a página Selecionar um projeto.
Selecionar um projeto do Cloud
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 permissão OAuth do complemento define o que o Google exibe aos usuários.

No console do Google Cloud, acesse Menu > APIs e serviços > Tela de permissão OAuth.
Acessar a tela de permissão OAuth
Selecione o tipo de usuário para seu app e clique em Criar.
Preencha o formulário de registro do app e clique em Salvar e continuar.
Por enquanto, pule a adição de escopos e clique em Salvar e continuar. No futuro, quando você criar um app para uso fora da organização do Google Workspace, será necessário adicionar e verificar os escopos de autorização exigidos pelo app.
Se você selecionou Externo como tipo de usuário, adicione usuários de teste:
1. Em Usuários de teste, clique em Adicionar usuários.
2. Insira seu endereço de e-mail e outros usuários de teste autorizados. Em seguida, clique em Salvar e continuar.
Leia o resumo do registro do seu app. Para fazer mudanças, clique em Editar. Se o registro do app estiver certo, clique em Voltar para o painel.

Crie e implemente uma Função do Cloud

Em um terminal local, ative o Cloud Functions, o Cloud Build e a API 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

Consiga o URL da função implantada. Para encontrar o URL, execute o comando a seguir e procure o campo url na seção httpsTrigger:
```
gcloud functions describe loadHomePage
```

Crie o arquivo deployment.json com o exemplo de código a seguir. Substitua URL pelo URL da função implantada da 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 atualize o Gmail para ver o complemento. Na barra de ferramentas à direita, procure um ícone de béquer.
Clique no ícone para abrir o complemento. Se solicitado, autorize o complemento.

Opcional: limpar

Para evitar cobranças na sua conta, exclua os recursos criados:

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 guia de início rápido. O ID do projeto do Cloud pode ser encontrado no console do Google Cloud na página Painel.

Próximas etapas

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