Encontrar um espaço de mensagem direta

Este guia explica como usar o método findDirectMessage no Space da API Google Chat para conferir detalhes sobre um espaço de mensagens diretas.

O Recurso Space representa um lugar onde as pessoas e os apps de chat podem enviar mensagens, compartilhar arquivos e colaborar. Há vários tipos de espaços:

  • As mensagens diretas são conversas entre dois usuários ou um usuário e um app do Chat.
  • Os grupos de chat são conversas entre três ou mais usuários e Apps de chat
  • Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaborar.

Como autenticar com autenticação de apps permite que um app de chat receba mensagens diretas O app do Chat tem acesso ao Google Chat (por exemplo, as mensagens diretas de que é membro). Como autenticar com A autenticação do usuário retorna mensagens diretas que o que o usuário autenticado pode acessar.

Pré-requisitos

Python

  • Python 3.6 ou superior
  • a ferramenta de gerenciamento de pacotes PIP;
  • As bibliotecas de cliente mais recentes do Google. Para instalar ou atualizar esses recursos, execute o seguinte comando na interface de linha de comando: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 ou mais recente
  • O npm ferramenta de gerenciamento de pacotes
  • As bibliotecas de cliente mais recentes do Google. Para instalar ou atualizar esses recursos, execute o seguinte comando na interface de linha de comando: 
    npm install @google-cloud/local-auth @googleapis/chat

Encontrar uma mensagem direta

Para encontrar uma mensagem direta no Google Chat, transmita o seguinte em sua solicitação:

  • Com a autenticação de apps, especifique o chat.bot escopo de autorização. Com autenticação do usuário especifique o escopo de autorização chat.spaces.readonly ou chat.spaces.
  • Chame o método Método findDirectMessage no recurso User, transmitindo name do outro usuário na mensagem direta retornar. Com autenticação do usuário este método retorna uma mensagem direta entre o usuário que fez a chamada e o usuário especificado. Com autenticação de apps, esse método retorna uma mensagem direta entre o app de chamada e o usuário especificado.
  • Para adicionar um usuário humano como participante do espaço, especifique users/{user}, em que {user} é o {person_id} do person da API People, ou o ID de um user na API Directory. Por exemplo, se a pessoa da API People resourceName for people/123456789, você pode adicionar o usuário ao espaço incluindo com users/123456789 como member.name.

Encontrar uma mensagem direta com a autenticação do usuário

Veja como encontrar uma mensagem direta com autenticação do usuário:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_find_dm_user.py.

  2. Inclua o seguinte código em chat_space_find_dm_user.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then returns details about a specified DM.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().findDirectMessage(

          # The other user in the direct message (DM) to return.
          #
          # Replace USER with a user name.
          name='users/USER'

      ).execute()

    # Prints details about the direct message.
    print(result)

if __name__ == '__main__':
    main()

  3. No código, substitua USER pelo name de um User no Google Chat.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_space_find_dm_user.py

Node.js

  1. Em seu diretório de trabalho, crie um arquivo chamado find-direct-message-space.js:

  2. Inclua o seguinte código em find-direct-message-space.js:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. No código, substitua USER pelo name de um User no Google Chat.

  4. No diretório de trabalho, execute o exemplo:

    node find-direct-message-space.js

A API Chat retorna uma instância do Space que detalha o DM especificado.

Encontrar uma mensagem direta com a autenticação de apps

Veja como encontrar uma mensagem direta com autenticação de apps:

Python

  1. No diretório de trabalho, crie um arquivo chamado chat_space_find_dm_app.py.

  2. Inclua o seguinte código em chat_space_find_dm_app.py:

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

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

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

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().findDirectMessage(

    # The other user in the direct message (DM) to return.
    #
    # Replace USER with a user name.
    name='users/USER'

).execute()

print(result)

  3. No código, substitua USER pelo name de um User no Google Chat.

  4. No diretório de trabalho, crie e execute o exemplo:

    python3 chat_space_find_dm_app.py

Node.js

  1. Em seu diretório de trabalho, crie um arquivo chamado app-find-direct-message-space.js:

  2. Inclua o seguinte código em app-find-direct-message-space.js:

    const chat = require('@googleapis/chat');

/**
* Find a direct message Chat space for a user.
* @return {!Promise<!Object>}
*/
async function findDirectMessageSpace() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.findDirectMessage(
      {name: 'users/USER'});
}

findDirectMessageSpace().then(console.log);

  3. No código, substitua USER pelo name de um User no Google Chat.

  4. No diretório de trabalho, execute o exemplo:

    node app-find-direct-message-space.js

A API Chat retorna uma instância do Space que detalha a mensagem direta especificada.