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 inicializar a CLI gcloud, execute o seguinte código:

    gcloud init
    

• Um projeto do Apps Script:
  • Use seu projeto do Google Cloud em vez do padrão criado automaticamente pelo Apps Script.
  • Para todos os escopos adicionados ao configurar a tela de permissão OAuth, você também precisa adicionar os escopos ao arquivo appsscript.json no seu projeto do Apps Script. Por exemplo, se você especificou o escopo chat.messages, adicione o seguinte:

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

  • Ative o serviço avançado do Google Workspace Events.

• Um projeto do Google Cloud com o faturamento ativado. Para assinaturas do Chat, você também precisa ativar a API Chat no seu projeto do Cloud e configurar os campos Nome do app, URL do avatar e Descrição. Para mais detalhes, consulte Criar um app do Google Chat.
• Requer autenticação e um escopo de autorização adequado para cada tipo de evento na assinatura:
  • Normalmente, exige autenticação do usuário com a tela de permissão OAuth configurada para o app. Ao configurar a tela de permissão, especifique um escopo para oferecer suporte a cada tipo de evento da assinatura. Para configurar a tela de consentimento e identificar os escopos necessários, consulte Escolher escopos.
  • Para se inscrever em um evento do Chat como um app do Chat, é necessário fazer a autenticação do app com aprovação única do administrador. A inscrição em um evento do Chat como um app do Chat está disponível na prévia para desenvolvedores.

Python

• Python 3.6 ou mais recente
• A ferramenta de gerenciamento de pacotes pip
• As bibliotecas de cliente mais recentes do Google para Python. Para instalar ou atualizar, execute o seguinte comando 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 inicializar a CLI gcloud, execute o seguinte código:

    gcloud init
    

• Um projeto do Google Cloud com o faturamento ativado. Para assinaturas do Chat, você também precisa ativar a API Chat no seu projeto do Cloud e configurar os campos Nome do app, URL do avatar e Descrição. Para mais detalhes, consulte Criar um app do Google Chat.
• Requer autenticação e um escopo de autorização adequado para cada tipo de evento na assinatura:
  • Normalmente, exige autenticação do usuário com a tela de permissão OAuth configurada para o app. Ao configurar a tela de permissão, especifique um escopo para oferecer suporte a cada tipo de evento da assinatura. Para configurar a tela de consentimento e identificar os escopos necessários, consulte Escolher escopos.
  • Para se inscrever em um evento do Chat como um app do Chat, é necessário fazer a autenticação do app com aprovação única do administrador. A inscrição em um evento do Chat como um app do Chat está disponível na prévia para desenvolvedores.

Console do Google Cloud

No console do Google Cloud, abra o projeto do Google Cloud para seu app e ative a API Google Workspace Events e a 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 o projeto do Cloud para seu app:

   gcloud config set project PROJECT_ID

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

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

   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 Google Cloud do seu app está selecionado.

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

   1. Digite um nome para o tópico, como workspace-events-topic.
   2. Deixe a opção Adicionar uma assinatura padrão selecionada. O Pub/Sub nomeia essa assinatura padrão de maneira semelhante ao nome do tópico, como workspace-events-topic-sub.
   3. Opcional: atualize ou configure outras propriedades do seu tópico.

3. Clique em Criar. O nome completo do tópico é formatado como projects/PROJECT_ID/topics/TOPIC_ID. Você vai 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 tópico, acesse o painel lateral e abra a guia Permissões.
   2. Clique em Adicionar principal.
   3. No campo Adicionar principais, adicione a conta de serviço do aplicativo do Google Workspace que entrega eventos à sua assinatura:
      1. Para eventos do Chat, chat-api-push@system.gserviceaccount.com.
      2. Prévia para desenvolvedores: para eventos do Drive, drive-api-event-push@system.gserviceaccount.com.
      3. Para eventos do Meet, meet-api-event-push@system.gserviceaccount.com.
   4. No menu Atribuir papéis, selecione Pub/Sub Publisher.
   5. Clique em Salvar. Pode levar alguns minutos para atualizar as permissões do seu tema.

gcloud

1. No seu projeto do Cloud, crie um tópico executando o seguinte comando:

   gcloud pubsub topics create TOPIC_ID

   Substitua TOPIC_ID por um ID exclusivo para o tópico, 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 verifique se o valor de PROJECT_ID é o ID do projeto do Cloud do seu app. Você vai usar o nome do tópico na próxima etapa e para criar a assinatura do Google Workspace mais tarde.

2. Conceda acesso para publicar mensagens no 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 é a saída da etapa anterior. Formatado como projects/PROJECT_ID/topics/TOPIC_ID.

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

     • Para receber eventos do Chat, use chat-api-push@system.gserviceaccount.com.
     • Prévia para desenvolvedores: para receber eventos do Drive, use drive-api-event-push@system.gserviceaccount.com.
     • Para receber eventos do Meet, use meet-api-event-push@system.gserviceaccount.com.

   Pode levar alguns minutos para atualizar as permissões do seu tema.

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 projeto do Apps Script, crie um 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 a que você está se inscrevendo, formatado como o nome completo do recurso. Por exemplo, para assinar um espaço do Google Chat com o ID AAAABBBB, use //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: um ou mais tipos de eventos que você quer assinar no recurso de destino. Formate como uma matriz de strings, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: o nome completo do tópico do Pub/Sub que você criou no projeto do Cloud. Formatado como projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: inclui todos os dados de recursos. Para limitar quais campos são incluídos, adicione o campo fieldMask e especifique pelo menos um campo para o recurso alterado. Somente assinaturas de recursos do Chat aceitam a inclusão de 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('credentials.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 que oferecem suporte a cada tipo de evento da assinatura. Formatado como uma matriz de strings. Para listar vários escopos, separe-os 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 a que você está se inscrevendo, formatado como o nome completo do recurso. Por exemplo, para assinar um espaço do Google Chat com o ID AAAABBBB, use //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: um ou mais tipos de eventos que você quer assinar no recurso de destino. Formate como uma matriz de strings, como 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: o nome completo do tópico do Pub/Sub que você criou no projeto do Cloud. Formatado como projects/PROJECT_ID/topics/TOPIC_ID.

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

     • True: inclui todos os dados de recursos. Para limitar quais campos são incluídos, adicione o campo fieldMask e especifique pelo menos um campo para o recurso alterado. Somente assinaturas de recursos do Chat aceitam a inclusão de dados de recursos.
     • False: exclui dados de recursos.

2. Para criar a assinatura do Google Workspace, execute o seguinte comando no terminal:

   python3 create_subscription.py

Console do Google Cloud

1. Acione um ou mais tipos de eventos no recurso de destino da sua assinatura do Google Workspace. Por exemplo, se você se inscreveu para receber novas mensagens em um espaço do Chat, envie uma mensagem para o 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 Google Cloud do seu app está selecionado.

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

4. Na tabela, encontre a assinatura do Pub/Sub para seu tópico e clique no nome dela.

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 sua assinatura do Google Workspace. Por exemplo, se você se inscreveu para receber novas mensagens em um espaço do Chat, poste uma mensagem nele.

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 da sua assinatura do Pub/Sub, formatado como projects/PROJECT_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 que um evento gere uma mensagem do Pub/Sub.

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

  # 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',
      'v1beta',
      credentials=CREDENTIALS,
      discoveryServiceUrl='https://workspaceevents.googleapis.com/$discovery/rest?version=v1beta&labels=DEVELOPER_PREVIEW&key=API_KEY',
  )

  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)