Actualizar un mensaje

En esta guía, se explica cómo usar el método update() en el recurso Message de la API de Google Chat para actualizar un mensaje de texto o de tarjeta en un espacio. Actualiza un mensaje para cambiar sus atributos, como lo que dice o el contenido de una tarjeta. También puedes anteponer un mensaje de texto a un mensaje de tarjeta o agregar una tarjeta a un mensaje de texto.

En la API de Chat, un mensaje de Chat se representa 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 mostrar interfaces de usuario estáticas o interactivas, recopilar información de los usuarios y enviar mensajes de forma privada. Para obtener más información sobre las funciones de mensajería disponibles para la API de Chat, consulta la descripción general de los mensajes de Google Chat.

Requisitos previos

Node.js

• Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

• Configura tu entorno:
  • Crea un proyecto de Google Cloud
  • Configura la pantalla de consentimiento de OAuth.
  • Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Node.js.
  • Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
    • Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    • Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Python

• Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

• Configura tu entorno:
  • Crea un proyecto de Google Cloud
  • Configura la pantalla de consentimiento de OAuth.
  • Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Python.
  • Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
    • Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    • Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Java

• Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

• Configura tu entorno:
  • Crea un proyecto de Google Cloud
  • Configura la pantalla de consentimiento de OAuth.
  • Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
  • Instala la biblioteca cliente de Cloud de Java.
  • Crea credenciales de acceso según la forma en que desees autenticar tu solicitud a la API de Google Chat:
    • Para autenticarte como usuario de Chat, crea credenciales de ID de cliente de OAuth y guárdalas como un archivo JSON llamado credentials.json en tu directorio local.
    • Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio y guárdalas como un archivo JSON llamado credentials.json.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

Apps Script

• Una cuenta de Google Workspace para empresas o Enterprise con acceso a Google Chat

• Configura tu entorno:
  • Crea un proyecto de Google Cloud
  • Configura la pantalla de consentimiento de OAuth.
  • Habilita y configura la API de Google Chat con un nombre, un ícono y una descripción para tu app de Chat.
  • Crea un proyecto independiente de Apps Script y activa el servicio de Chat avanzado.
  • En esta guía, debes usar la autenticación de usuario o de app. Para autenticarte como la app de Chat, crea credenciales de cuenta de servicio. Para conocer los pasos, consulta Autentícate y autoriza como una app de Google Chat.
• Elige un alcance de autorización según si deseas autenticarte como usuario o como la app de Chat.

En los ejemplos de código de esta página, se usa la interfaz de la API de gRPC con las bibliotecas cliente de Google Cloud. Como alternativa, puedes usar la interfaz de la API de REST. Para obtener más información sobre las interfaces de gRPC y REST, consulta la descripción general de la API de Google Chat.

Actualiza un mensaje en nombre de un usuario

Con la autenticación del usuario, solo se puede actualizar el texto de un mensaje.

Para actualizar un mensaje con la autenticación del usuario, pasa lo siguiente en tu solicitud:

• Especifica el alcance de autorización chat.messages.
• Realiza una llamada al método UpdateMessage().
• Pasa message como una instancia de Message con lo siguiente:
  • El campo name establecido en el mensaje que se actualizará, que incluye un ID de espacio y un ID de mensaje.
  • El campo text se establece con el texto nuevo.
• Pasa updateMask con el valor text.

Si el mensaje actualizado es un mensaje de tarjeta, el texto se antepone a las tarjetas (que se siguen mostrando).

A continuación, te indicamos cómo actualizar un mensaje o anteponer un mensaje de texto a un mensaje de tarjeta con autenticación de usuario:

Node.js

chat/client-libraries/cloud/update-message-user-cred.js

Ver en GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages'];

// This sample shows how to update a message with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Updated with user credential!'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_user_cred.py

Ver en GitHub

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.messages"]

# This sample shows how to update a message with user credential
def update_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Updated with user credential!"
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageUserCred.java

Ver en GitHub

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with user credential.
public class UpdateMessageUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Updated with user credential!"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("text"));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Ver en GitHub

/**
 * This sample shows how to update a message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages'
 * referenced in the manifest file (appsscript.json).
 */
function updateMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Updated with user credential!'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  });

  // Handle the response
  console.log(response);
}

Para ejecutar esta muestra, reemplaza lo siguiente:

• SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
• MESSAGE_NAME: Es el ID del name del mensaje. Puedes obtener el ID 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.

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

Actualiza un mensaje como la app de Chat

Con la autenticación de la app, se pueden actualizar tanto el texto como las tarjetas de un mensaje.

Para actualizar un mensaje con la autenticación de la app, pasa lo siguiente en tu solicitud:

• Especifica el alcance de autorización chat.bot.
• Realiza una llamada al método UpdateMessage().
• Pasa message como una instancia de Message con lo siguiente:
  • El campo name establecido en el mensaje que se actualizará, que incluye un ID de espacio y un ID de mensaje.
  • Es el campo text establecido con el texto nuevo si necesita actualizarse.
  • Es el campo cardsV2 establecido con las tarjetas nuevas si necesitan actualizarse.
• Pasa updateMask con la lista de campos que se actualizarán, como text y cardsV2.

Si el mensaje actualizado es un mensaje de tarjeta y se actualiza el texto, el texto actualizado se antepone a las tarjetas (que se siguen mostrando). Si el mensaje actualizado es un mensaje de texto y se actualizan las tarjetas, las tarjetas actualizadas se agregan al texto (que se sigue mostrando).

Sigue estos pasos para actualizar el texto y las tarjetas de un mensaje con autenticación de la app:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js

Ver en GitHub

import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to update a message with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Text updated with app credential!',
      cardsV2 : [{ card: { header: {
        title: 'Card updated with app credential!',
        imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
      }}}]
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text', 'cards_v2']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_app_cred.py

Ver en GitHub

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to update a message with app credential
def update_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Text updated with app credential!",
            "cards_v2" : [{ "card": { "header": {
                "title": 'Card updated with app credential!',
                "image_url": 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
            }}}]
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text,cardsV2"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageAppCred.java

Ver en GitHub

import com.google.apps.card.v1.Card;
import com.google.apps.card.v1.Card.CardHeader;
import com.google.chat.v1.CardWithId;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with app credential.
public class UpdateMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Text updated with app credential!")
          .addCardsV2(CardWithId.newBuilder().setCard(Card.newBuilder()
            .setHeader(CardHeader.newBuilder()
              .setTitle("Card updated with app credential!")
              .setImageUrl("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg")))))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addAllPaths(List.of("text", "cards_v2")));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Ver en GitHub

/**
 * This sample shows how to update a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function updateMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Text updated with app credential!',
    cardsV2 : [{ card: { header: {
      title: 'Card updated with app credential!',
      imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
    }}}]
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text,cardsV2';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  }, getHeaderWithAppCredentials());

  // Handle the response
  console.log(response);
}

Para ejecutar esta muestra, reemplaza lo siguiente:

• SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces() o desde la URL del espacio.
• MESSAGE_NAME: Es el ID del name del mensaje. Puedes obtener el ID 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.

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

Temas relacionados

• Dar formato a un mensaje
• Borra un mensaje.
• Obtén detalles sobre un mensaje.
• Enumera los mensajes en un espacio.
• Envíeles un mensaje.