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 devolver detalles sobre un mensaje de texto o de tarjeta.

En la API de Chat, los mensajes de Chat se representan con el Recurso Message. Si bien los usuarios de Chat solo pueden enviar mensajes que contengan texto Las apps de Chat pueden usar muchas otras funciones de mensajería, como las siguientes: mostrar interfaces de usuario estáticas o interactivas, recopilar información de usuarios y la entrega de mensajes de forma privada. Para obtener más información sobre los mensajes disponibles para la API de Chat, consulta la Descripción general de los mensajes de Google Chat.

Requisitos previos

Python

Recibe un mensaje con la autenticación de usuario

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

  • Especifica el permiso de autorización chat.messages.readonly o chat.messages.
  • Llama al Método get en la Recurso Message.
  • Establece name en el nombre del recurso del mensaje que se obtendrá.

En el siguiente ejemplo, se recibe un mensaje con Autenticación de usuarios:

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 message.
    print(result)

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es un nombre de espacio, que puedes obtener desde el Método spaces.list en la API de Chat o 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 nombre personalizado se asigna al mensaje en el momento de su creación.

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

    python3 chat_message_get_user.py

La API de Chat devuelve 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 autenticación de apps, pasa lo siguiente en tu solicitud:

  • Especifica el alcance de la autorización chat.bot.
  • Llama al Método get en la Recurso Message.
  • Establece name en el nombre del recurso del mensaje que se obtendrá.

En el siguiente ejemplo, se recibe un mensaje con 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: el name del espacio en el que el elemento un mensaje nuevo, el cual puedes obtener en la 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 nombre personalizado se asigna al mensaje en el momento de su creación.

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

    python3 chat_get_message_app.py

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