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

En esta guía, se explica cómo usar el método findDirectMessage en Space recurso de la API de Google Chat para obtener detalles sobre un espacio de mensaje directo (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 Apps de Chat
  • Los espacios con nombre son lugares persistentes donde las personas envían mensajes, y colaborar.

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

Requisitos previos

Python

Node.js

Cómo buscar un mensaje directo

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

  • Con la autenticación de apps, especifica la Permiso de autorización de chat.bot. Con autenticación de usuarios, especifica el permiso de 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 MD que se debe devolver. Con autenticación de usuarios, este método muestra un MD entre el usuario que realiza la llamada y el usuario especificado. Con autenticación de aplicación, 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 la {person_id} de la person de la API de People o el ID de un user en la API de Directory. Por ejemplo, si la persona de la API de People resourceName es people/123456789, puedes agregar al usuario al espacio incluyendo un membresía con users/123456789 como member.name.

Busca un mensaje directo con autenticación de usuario

Aquí le mostramos cómo encontrar un mensaje directo con Autenticación de usuarios:

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 direct message.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. En el código, reemplaza USER por el name de un User en Google Chat.

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

    python3 chat_space_find_dm_user.py
    

Node.js

  1. En tu 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 el 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 devuelve una instancia de Space en la que se detalle la DM especificada.

Busca un mensaje directo con la autenticación de la app

Aquí le mostramos cómo encontrar un mensaje directo con Autenticación de la app:

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 el name de un User en Google Chat.

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

    python3 chat_space_find_dm_app.py
    

Node.js

  1. En tu 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 el 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 devuelve una instancia de Space que detalla el DM especificado