Cómo buscar un espacio de mensaje directo (MD)

En esta guía, se explica cómo usar el método findDirectMessage en el recurso Space de la API de Google Chat para obtener detalles sobre un espacio de mensajes directos (DM).

El recurso Space representa un lugar donde las personas y las apps de Chat pueden enviar mensajes, compartir archivos y colaborar. Existen varios tipos de espacios:

  • Los mensajes directos (MD) son conversaciones entre dos usuarios, o un usuario, y una app de Chat.
  • Los chats en grupo son conversaciones entre tres o más usuarios y las apps de Chat.
  • Los espacios con nombre son lugares persistentes en los que las personas envían mensajes, comparten archivos y colaboran.

La autenticación con la autenticación de la app permite que una app de Chat reciba MD a los que esta tiene acceso en Google Chat (por ejemplo, MD de los que es miembro). La autenticación con autenticación de usuario muestra los MD a los que el usuario autenticado tiene acceso.

Requisitos previos

Python

  • Python 3.6 o superior
  • La herramienta de administración de paquetes pip

  • Las bibliotecas cliente de Google más recientes para Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.

  • Autorización configurada para la app de Chat. La búsqueda de un mensaje directo admite lo siguiente:

Node.js

  • Node.js y npm

  • Las bibliotecas cliente de Google más recientes para Node.js. Para instalarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:

    npm install @google-cloud/local-auth @googleapis/chat
  • Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.

  • Autorización configurada para la app de Chat. La búsqueda de un mensaje directo admite lo siguiente:

Buscar un mensaje directo

Para encontrar un mensaje directo en Google Chat, pasa lo siguiente en la solicitud:

  • Con la autenticación de la app, especifica el alcance de la autorización chat.bot. Con la autenticación de usuarios, especifica el alcance de la autorización chat.spaces.readonly o chat.spaces.
  • Llama al método findDirectMessage en el recurso User y pasa el name del otro usuario en el DM para que se muestre. Con la autenticación de usuario, este método muestra un MD entre el usuario que realiza la llamada y el usuario especificado. Con la autenticación de la app, este método muestra un MD entre la app que realiza la llamada y el usuario especificado.
  • Para agregar un usuario humano como miembro del espacio, especifica users/{user}, en el que {user} es el {person_id} del person de la API de People o el ID de un user en la API de Directory. Por ejemplo, si la persona resourceName de la API de People es people/123456789, puedes agregar el usuario al espacio incluyendo una membresía con users/123456789 como member.name.

Cómo buscar un mensaje directo con autenticación de usuario

A continuación, te mostramos cómo encontrar un mensaje directo con la autenticación de usuario:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_space_find_dm_user.py.

  2. Incluye el siguiente código en 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 created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. En el código, reemplaza USER por la name de un User en Google Chat.

  4. En el directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_space_find_dm_user.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado find-direct-message-space.js.

  2. Incluye el siguiente código en 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. En el código, reemplaza USER por la name de un User en Google Chat.

  4. En tu directorio de trabajo, ejecuta la muestra:

    node find-direct-message-space.js

La API de Chat muestra una instancia de Space en la que se detalla el DM especificado.

Cómo buscar un mensaje directo con la autenticación de la app

Para encontrar un mensaje directo con la autenticación de la app, sigue estos pasos:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_space_find_dm_app.py.

  2. Incluye el siguiente código en 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. En el código, reemplaza USER por la name de un User en Google Chat.

  4. En el directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_space_find_dm_app.py

Node.js

  1. En el directorio de trabajo, crea un archivo llamado app-find-direct-message-space.js.

  2. Incluye el siguiente código en 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. En el código, reemplaza USER por la name de un User en Google Chat.

  4. En tu directorio de trabajo, ejecuta la muestra:

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

La API de Chat muestra una instancia de Space que detalla el DM especificado.