Criar uma assinatura do Google Workspace

Apps Script

• Para usar os comandos da CLI do Google Cloud neste guia:
  1. Instale o Google Cloud CLI.
  2. Para inicialize a CLI gcloud e execute este código:

    gcloud init
    

• um projeto do Google Cloud; com o faturamento ativado. Para assinaturas do Chat, você precisa: ativar a API Chat no projeto do Cloud configure o Nome do app, o URL do avatar e a Descrição campos. Para mais detalhes, consulte Criar um app do Google Chat.
• Exige autenticação do usuário com a tela de permissão OAuth configurada para o app. Ao configurar a tela de consentimento, especifique um escopo para oferecem suporte a cada tipo de evento da assinatura. Para configurar o consentimento e identificar os escopos necessários, consulte Escolher escopos.

• Um projeto do Apps Script:
  • Use seu projeto do Google Cloud em vez do projeto padrão criado automaticamente pelo Apps Script.
  • Para os escopos adicionados para configurar a tela de permissão OAuth, também é necessário adicionar o escopos para o arquivo appsscript.json no seu projeto do Apps Script. Exemplo:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • Ativar o serviço avançado Google Workspace Events.

Python

• Python 3.6 ou superior
• a ferramenta de gerenciamento de pacotes PIP;
• As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte na interface de linha de comando:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

• Para usar os comandos da CLI do Google Cloud neste guia:
  1. Instale o Google Cloud CLI.
  2. Para inicialize a CLI gcloud e execute este código:

    gcloud init
    

• um projeto do Google Cloud; com o faturamento ativado. Para assinaturas do Chat, você precisa: ativar a API Chat no projeto do Cloud configure o Nome do app, o URL do avatar e a Descrição campos. Para mais detalhes, consulte Criar um app do Google Chat.
• Exige autenticação do usuário com a tela de permissão OAuth configurada para o app. Ao configurar a tela de consentimento, especifique um escopo para oferecem suporte a cada tipo de evento da assinatura. Para configurar o consentimento e identificar os escopos necessários, consulte Escolher escopos.

Console do Google Cloud

No console do Google Cloud, abra o projeto do Google Cloud do seu app e ative a API Google Workspace Events e API Pub/Sub:

Ativar as APIs

gcloud

1. No diretório de trabalho, faça login na sua Conta do Google:

   gcloud auth login
   

2. Defina seu projeto como o projeto do Cloud do seu app:

   gcloud config set project PROJECT_ID
   

   Substitua PROJECT_ID pelo ID do projeto do Cloud do seu app.

3. Ative a API Google Workspace Events e o Google Cloud Pub/Sub API:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Console do Google Cloud

1. No console do Google Cloud, acesse a página do Pub/Sub:

   Acessar o Google Cloud Pub/Sub

   Verifique se o projeto do Cloud para seu app está selecionado.

2. Clique em add_box Criar tópico e faça o seguinte:

   1. Insira um nome para o tópico, como workspace-events-topic.
   2. Deixe a opção Adicionar uma assinatura padrão selecionada. O Pub/Sub dá esse nome padrão similar ao nome do tópico, como workspace-events-topic-sub:
   3. Opcional: atualizar ou configurar outras propriedades para seu tópico.

3. Clique em Criar. O nome completo do seu tópico está formatado como projects/PROJECT_ID/topics/TOPIC_ID: Você usará esse nome completo em uma etapa posterior.

4. Conceda acesso para publicar mensagens do Pub/Sub no seu tópico:

   1. Na página do seu tópico, acesse o painel lateral e abra o Guia Permissões.
   2. Clique em Adicionar principal.
   3. No campo Adicionar participantes, adicione a conta de serviço do aplicativo do Google Workspace que envia eventos para assinatura:
      1. Para eventos do Chat, chat-api-push@system.gserviceaccount.com:
      2. Nos eventos do Meet, meet-api-event-push@system.gserviceaccount.com:
   4. No menu Atribuir funções, selecione Pub/Sub Publisher.
   5. Clique em Salvar. A atualização das permissões pode levar alguns minutos para seu tópico.

gcloud

1. No projeto do Cloud, execute o comando a seguir para criar um tópico comando:

   gcloud pubsub topics create TOPIC_ID
   

   Substitua TOPIC_ID por um ID exclusivo para o tópico, como como workspace-events-topic.

   A saída mostra o nome completo do tópico, formatado como projects/PROJECT_ID/topics/TOPIC_ID: Anote o nome e confirme se o valor PROJECT_ID é o ID do projeto do Cloud. para seu app. Você usará o nome do tópico na etapa a seguir e para criar a assinatura do Google Workspace depois.

2. Conceda acesso para publicar mensagens no seu tópico:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   Substitua:

   • TOPIC_NAME: o nome completo do tópico, que é o da etapa anterior. Formatado como projects/PROJECT_ID/topics/TOPIC_ID:

   • GOOGLE_WORKSPACE_APPLICATION: o aplicativo do Google Workspace que precisa entregar eventos para sua assinatura:

     • Para receber eventos do Chat, use chat-api-push@system.gserviceaccount.com:
     • Para receber eventos do Meet, use meet-api-event-push@system.gserviceaccount.com:

   A atualização das permissões do tópico pode levar alguns minutos.

3. Crie uma assinatura do Pub/Sub para o tópico:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   Substitua:

   • SUBSCRIPTION_NAME: um nome para sua assinatura. como workspace-events-subscription.
   • TOPIC_NAME: o nome do tópico que você criou na etapa anterior.

Apps Script

1. No seu projeto do Apps Script, crie um novo arquivo de script chamado createSubscription e adicione o seguinte código:

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   Substitua:

   • TARGET_RESOURCE: o recurso do Google Workspace que você está assinando, formatado como o nome completo do recurso. Para exemplo, para se inscrever em um espaço do Google Chat com o ID AAAABBBB, use //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: um ou mais tipos de evento em que você quer se inscrever no recurso de destino. Formatar como um matriz de strings, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: o nome completo do tópico do Pub/Sub que que você criou no projeto do Cloud. Formatado como projects/PROJECT_ID/topics/TOPIC_ID:

   • RESOURCE_DATA: um booleano que especifica se o A assinatura inclui dados de recursos no payload:

     • True: inclui todos os dados de recursos. Para limitar quais campos são incluído, adicione o fieldMask e especifique pelo menos um campo para o recurso alterado. Somente inscrições no suporte aos recursos do Chat, como dados de recursos.
     • False: exclui dados de recursos.

2. Para criar a assinatura do Google Workspace, execute a função createSubscription no seu projeto do Apps Script.

Python

1. No diretório de trabalho, crie um arquivo chamado create_subscription.py e adicione o seguinte código:

   """Create subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   Substitua:

   • SCOPES: um ou mais escopos do OAuth compatíveis com cada tipo de evento. para a assinatura. Formatado como uma matriz de strings. Para listar vários escopos, separe por vírgulas. Por exemplo, 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'.
   • TARGET_RESOURCE: o recurso do Google Workspace que você está assinando, formatado como o nome completo do recurso. Para exemplo, para se inscrever em um espaço do Google Chat com o ID AAAABBBB, use //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: um ou mais tipos de evento em que você quer se inscrever no recurso de destino. Formatar como um matriz de strings, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: o nome completo do tópico do Pub/Sub que que você criou no projeto do Cloud. Formatado como projects/PROJECT_ID/topics/TOPIC_ID:

   • RESOURCE_DATA: um booleano que especifica se o A assinatura inclui dados de recursos no payload:

     • True: inclui todos os dados de recursos. Para limitar quais campos são incluído, adicione o fieldMask e especifique pelo menos um campo para o recurso alterado. Somente inscrições no suporte aos recursos do Chat, como dados de recursos.
     • False: exclui dados de recursos.

2. Para criar a assinatura do Google Workspace, execute o seguinte em seu terminal:

   python3 create_subscription.py
   

Console do Google Cloud

1. Acione um ou mais tipos de eventos no recurso de destino da assinatura do Google Workspace. Por exemplo, se você assinou novos mensagens em um espaço do Chat, postar uma mensagem no espaço.

2. No console do Google Cloud, acesse a página do Pub/Sub:

   Ir para o Pub/Sub

   Verifique se o projeto do Cloud para seu app está selecionado.

3. No menu Pub/Sub, clique em Assinaturas.

4. Na tabela, encontre a assinatura do Pub/Sub do seu tópico e clique em o nome da assinatura.

5. Clique na guia Mensagens.

6. Clique em Pull. Pode levar alguns minutos para que um evento gere uma Mensagem do Pub/Sub.

gcloud

1. Acione um ou mais tipos de eventos no recurso de destino da assinatura do Google Workspace. Por exemplo, se você assinou novos mensagens em um espaço do Chat, postar uma mensagem no espaço.

2. Execute este comando:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   Substitua:

   • PUBSUB_SUBSCRIPTION_NAME: o nome completo do Assinatura do Pub/Sub, formatada como projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: o número máximo de mensagens do Pub/Sub que você quer extrair.

   Pode levar alguns minutos para um evento gerar um Pub/Sub mensagem.