Cómo obtener detalles sobre un mensaje

En esta guía, se explica cómo usar el método get en el recurso Message de la API de Google Chat para mostrar detalles sobre un mensaje de texto o de tarjeta.

El recurso Message representa un mensaje de texto o tarjeta en Google Chat. Puedes create, get, update o delete un mensaje en la API de Google Chat si llamas a los métodos correspondientes. Para obtener más información sobre los mensajes de texto y de tarjetas, consulta la descripción general de los mensajes de Google Chat.

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
    
  • 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.
  • La autorización configurada para la app de Chat. Obtener un mensaje admite ambos métodos de autenticación:

    • La autenticación del usuario, con el alcance de autorización chat.messages.readonly o chat.messages, puede obtener mensajes a los que el usuario tiene acceso.
    • La autenticación de la app, con el alcance de autorización de chat.bot, puede obtener mensajes que se enviaron a la app.

Recibe un mensaje con la autenticación de usuario

Para obtener detalles sobre un mensaje con autenticación de usuario, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.messages.readonly o chat.messages.
  • Llama al método get en el recurso Message.
  • Establece name en el nombre del recurso del mensaje que deseas obtener.

En el siguiente ejemplo, se recibe un mensaje con la autenticación de usuario:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_message_get_user.py.
  2. Incluye el siguiente código en chat_message_get_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.messages.readonly"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then gets a message.
        '''
    
        # 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().messages().get(
    
            # The message to get.
            #
            # Replace SPACE with a space name.
            # Obtain the space name from the spaces resource of Chat API,
            # or from a space's URL.
            #
            # Replace MESSAGE with a message name.
            # Obtain the message name from the response body returned
            # after creating a message asynchronously with Chat REST API.
            name = 'spaces/SPACE/messages/MESSAGE'
    
        ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. En el código, reemplaza lo siguiente:

    • SPACE: Es un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.
    • MESSAGE: Es un nombre de mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de la creación.
  4. En el directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_message_get_user.py
    

La API de Chat muestra una instancia de Message que detalla el mensaje especificado.

Recibe un mensaje con la autenticación de la app

Para obtener detalles sobre un mensaje con la autenticación de la app, pasa lo siguiente en la solicitud:

  • Especifica el alcance de la autorización de chat.bot.
  • Llama al método get en el recurso Message.
  • Establece name en el nombre del recurso del mensaje que deseas obtener.

En el siguiente ejemplo, se recibe un mensaje con la autenticación de la app:

Python

  1. En el directorio de trabajo, crea un archivo llamado chat_get_message_app.py.
  2. Incluye el siguiente código en chat_get_message_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)
    
    # Get a Chat message.
    result = chat.spaces().messages().get(
    
        # The message to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name='spaces/SPACE/messages/MESSAGE'
    
      ).execute()
    
    # Print Chat API's response in your command line interface.
    print(result)
    
  3. En el código, reemplaza lo siguiente:

    • SPACE: Es el name del espacio en el que se publica el mensaje, que puedes obtener desde el método spaces.list en la API de Chat o desde la URL de un espacio.

    • MESSAGE: Es el nombre del mensaje, que puedes obtener del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en la creación.

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

    python3 chat_get_message_app.py
    

La API de Chat muestra una instancia de Message que detalla el mensaje especificado.