Guia de início rápido do Google Apps Script

Os tutoriais rápidos explicam como configurar e executar um app que chama uma API do Google Workspace.

Os guias de início rápido do Google Workspace usam as bibliotecas de cliente da API para processar alguns detalhes do fluxo de autenticação e autorização. Recomendamos que você use as bibliotecas de cliente para seus próprios apps. Este guia de início rápido usa uma abordagem de autenticação simplificada que é adequada para um ambiente de teste. Para um ambiente de produção, recomendamos que você aprenda sobre autenticação e autorização antes de escolher as credenciais de acesso adequadas para o app.

Crie um Apps Script do Google que faça solicitações à API Google Chat.

Objetivos

  • Configurar o ambiente.
  • Crie e configure o script.
  • Execute o script.

Pré-requisitos

Configurar seu projeto do Cloud

Se você estiver usando um novo projeto do Google Cloud para concluir este guia de início rápido, será necessário configurá-lo e adicionar a si mesmo como usuário de teste. Se você já concluiu essas etapas para seu projeto do Cloud, pule para a próxima seção.

Abra seu projeto do Cloud no console do Google Cloud

Se ainda não estiver aberto, abra o projeto do Cloud que você pretende usar para este exemplo:

  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.

Ativar a API Chat

Antes de usar as APIs do Google, você precisa ativá-las em um projeto do Google Cloud. É possível ativar uma ou mais APIs em um único projeto do Google Cloud.

  • No console do Google Cloud, ative a API Google Chat.

    Ativar a API

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

    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.

Configurar o app Google Chat

Para chamar a API Google Chat, você precisa configurar um app do Google Chat. Para todas as solicitações de gravação, o Google Chat atribui o app do Google Chat na interface usando as informações a seguir.

  1. No console do Google Cloud, acesse a página Configuração da API Chat:

    Acessar a página de configuração da API Chat

  2. Em Informações do aplicativo, insira as seguintes informações:

    1. No campo Nome do app, digite Chat API quickstart app.
    2. No campo URL do avatar, insira https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. No campo Descrição, use Quickstart for calling the Chat API.

  3. Em Recursos interativos, clique em Ativar recursos interativos para desativar os recursos interativos do app do Chat.

  4. Clique em Salvar.

Criar o script

  1. Acesse script.google.com/create e crie um novo script.
  2. Substitua o conteúdo do editor de script pelo seguinte código:

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.spaces) {
      responsePage.spaces.forEach((space) => console.log(space));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Clique em Salvar .
  2. Clique em Untitled project, digite Quickstart e clique em Rename.

Configurar o script

Copiar o número do projeto do Cloud

  1. No console do Google Cloud, acesse Menu > IAM e administrador > Configurações.

    Acessar as configurações do IAM e do administrador

  2. No campo Número do projeto, copie o valor.
  1. Abra o projeto do Apps Script.
  2. Clique em Configurações do projeto .
  3. Em Projeto do Google Cloud Platform (GCP), clique em Mudar projeto.
  4. Em Número do projeto do GCP, cole o número do projeto do Google Cloud.
  5. Clique em Configurar projeto.

Ativar a API Google Chat

Abra o projeto do Apps Script.

  1. Clique em Configurações do projeto .
  2. Em Configurações gerais, ative a opção Mostrar arquivo de manifesto "appsscript.json" no editor.
  3. Clique em Editor , selecione o arquivo appscript.json e substitua o conteúdo pelo seguinte código:

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.readonly"
  ],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [{
      "userSymbol": "Chat",
      "version": "v1",
      "serviceId": "chat"
    }]
  }
}

Executar a amostra

No editor do Apps Script, clique em Run.

Na primeira vez que você executar o exemplo, será necessário autorizar o acesso:

  1. Clique em Analisar permissões.
  2. Escolha uma conta.
  3. Clique em Permitir.

O registro de execução do script aparece na parte de baixo da janela.

Próximas etapas