Zaktualizuj wiadomość

Ten przewodnik wyjaśnia, jak używać metody update w zasobie Message interfejsu Google Chat API do aktualizowania wiadomości tekstowej lub karty w pokoju. Zaktualizuj wiadomość, aby zmienić jej atrybuty, np. treść lub zawartość karty. Możesz też dodać wiadomość tekstową przed wiadomością z kartą lub dołączyć kartę do wiadomości tekstowej.

W interfejsie Chat API wiadomość na czacie jest reprezentowana przez zasób Message. Użytkownicy Google Chat mogą wysyłać tylko wiadomości tekstowe, ale aplikacje Google Chat mogą korzystać z wielu innych funkcji przesyłania wiadomości, w tym wyświetlać statyczne lub interaktywne interfejsy użytkownika, zbierać informacje od użytkowników i dostarczać wiadomości prywatnie. Więcej informacji o funkcjach przesyłania wiadomości dostępnych w interfejsie Chat API znajdziesz w artykule Omówienie wiadomości Google Chat.

Wymagania wstępne

Node.js

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.

• Skonfiguruj środowisko:
  • Utwórz projekt Google Cloud.
  • Skonfiguruj ekran zgody OAuth.
  • Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji Google Chat.
  • Zainstaluj bibliotekę klienta Cloud dla Node.js .
  • Utwórz dane logowania na podstawie sposodu uwierzytelniania w żądaniu do interfejsu Google Chat API request:
    • Aby uwierzytelnić się jako użytkownik Google Chat, utwórz dane logowania identyfikatora klienta OAuth i zapisz je w pliku JSON o nazwie credentials.json w katalogu lokalnym.
    • Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja Google Chat.

Python

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.

• Skonfiguruj środowisko:
  • Utwórz projekt Google Cloud.
  • Skonfiguruj ekran zgody OAuth.
  • Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji Google Chat.
  • Zainstaluj bibliotekę klienta Cloud dla Pythona.
  • Utwórz dane logowania na podstawie sposodu uwierzytelniania w żądaniu do interfejsu Google Chat API request:
    • Aby uwierzytelnić się jako użytkownik Google Chat, utwórz dane logowania identyfikatora klienta OAuth i zapisz je w pliku JSON o nazwie credentials.json w katalogu lokalnym.
    • Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja Google Chat.

Java

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.

• Skonfiguruj środowisko:
  • Utwórz projekt Google Cloud.
  • Skonfiguruj ekran zgody OAuth.
  • Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji Google Chat.
  • Zainstaluj bibliotekę klienta Cloud dla Javy .
  • Utwórz dane logowania na podstawie sposodu uwierzytelniania w żądaniu do interfejsu Google Chat API request:
    • Aby uwierzytelnić się jako użytkownik Google Chat, utwórz dane logowania identyfikatora klienta OAuth i zapisz je w pliku JSON o nazwie credentials.json w katalogu lokalnym.
    • Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania konta usługi i zapisz je w pliku JSON o nazwie credentials.json.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja Google Chat.

Apps Script

• Konto Google Workspace w wersji Business lub Enterprise z dostępem do Google Chat.

• Skonfiguruj środowisko:
  • Utwórz projekt Google Cloud.
  • Skonfiguruj ekran zgody OAuth.
  • Włącz i skonfiguruj interfejs Google Chat API, podając nazwę, ikonę i opis aplikacji Google Chat.
  • Utwórz samodzielny projekt Apps Script, i włącz zaawansowaną usługę Google Chat.
  • W tym przewodniku musisz użyć uwierzytelniania użytkownika lub aplikacji. Aby uwierzytelnić się jako aplikacja Google Chat, utwórz dane logowania konta usługi. Instrukcje znajdziesz w artykule Uwierzytelnianie i autoryzowanie jako aplikacja Google Chat.
• Wybierz zakres autoryzacji w zależności od tego, czy chcesz uwierzytelnić się jako użytkownik, czy jako aplikacja Google Chat.

Przykłady kodu na tej stronie korzystają z interfejsu gRPC API z bibliotekami klienta Google Cloud. Możesz też użyć interfejsu REST API. Więcej informacji o interfejsach gRPC i REST znajdziesz w artykule Omówienie interfejsu Google Chat API.

Aktualizowanie wiadomości w imieniu użytkownika

W przypadku uwierzytelniania użytkownika, można aktualizować tylko tekst wiadomości.

Aby zaktualizować wiadomość za pomocą uwierzytelniania użytkownika, w żądaniu podaj te informacje:

• Określ zakres autoryzacji chat.messages.
• Wywołaj UpdateMessage metodę.
• Przekaż message jako instancję Message z tymi informacjami:
  • Pole name ustawione na wiadomość do zaktualizowania, która zawiera identyfikator pokoju i identyfikator wiadomości.
  • Pole text ustawione na nowy tekst.
• Przekaż updateMask z wartością text.

Jeśli zaktualizowana wiadomość jest wiadomością z kartą, tekst zostanie dodany przed kartami (które nadal będą się wyświetlać).

Oto jak zaktualizować wiadomość lub dodać wiadomość tekstową przed wiadomością z kartą za pomocą uwierzytelniania użytkownika:

Node.js

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

Wyświetl w GitHubie

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);
}

await main();

Python

chat/client-libraries/cloud/update_message_user_cred.py

Wyświetl w GitHubie

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

Wyświetl w GitHubie

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

Wyświetl w GitHubie

/**
 * 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);
}

Aby uruchomić ten przykład, zastąp te elementy:

• SPACE_NAME: identyfikator z pola name. Możesz go uzyskać, wywołując metodę ListSpaces lub z adresu URL pokoju.
• MESSAGE_NAME: identyfikator z pola name wiadomości. Możesz go uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardowej nazwy przypisanej do wiadomości podczas jej tworzenia.

Interfejs Chat API zwraca instancję Message , która zawiera szczegółowe informacje o zaktualizowanej wiadomości.

Aktualizowanie wiadomości jako aplikacja Google Chat

W przypadku uwierzytelniania aplikacji, można aktualizować zarówno tekst, jak i karty wiadomości.

Aby zaktualizować wiadomość za pomocą uwierzytelniania aplikacji, w żądaniu podaj te informacje:

• Określ zakres autoryzacji chat.bot.
• Wywołaj UpdateMessage metodę.
• Przekaż message jako instancję Message z tymi informacjami:
  • Pole name ustawione na wiadomość do zaktualizowania, która zawiera identyfikator pokoju i identyfikator wiadomości.
  • Pole text ustawione na nowy tekst, jeśli trzeba go zaktualizować.
  • Pole cardsV2 ustawione na nowe karty, jeśli trzeba je zaktualizować.
• Przekaż updateMask z listą pól do zaktualizowania, np. text i cardsV2.

Jeśli zaktualizowana wiadomość jest wiadomością z kartą , a tekst został zaktualizowany , zaktualizowany tekst zostanie dodany przed kartami (które nadal będą się wyświetlać). Jeśli zaktualizowana wiadomość jest wiadomością tekstową, a karty zostały zaktualizowane, zaktualizowane karty zostaną dołączone do tekstu (który nadal będzie się wyświetlać).

Oto jak zaktualizować tekst i karty wiadomości za pomocą uwierzytelniania aplikacji:

Node.js

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

Wyświetl w GitHubie

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);
}

await main();

Python

chat/client-libraries/cloud/update_message_app_cred.py

Wyświetl w GitHubie

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

Wyświetl w GitHubie

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

Wyświetl w GitHubie

/**
 * 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);
}

Aby uruchomić ten przykład, zastąp te elementy:

• SPACE_NAME: identyfikator z pola name. Możesz go uzyskać, wywołując metodę ListSpaces lub z adresu URL pokoju.
• MESSAGE_NAME: identyfikator z pola name wiadomości. Możesz go uzyskać z treści odpowiedzi zwróconej po asynchronicznym utworzeniu wiadomości za pomocą interfejsu Chat API lub z niestandardowej nazwy przypisanej do wiadomości podczas jej tworzenia.

Interfejs Chat API zwraca instancję Message , która zawiera szczegółowe informacje o zaktualizowanej wiadomości.

Asynchroniczne aktualizowanie kart

Wersja przedpremierowa dla programistów: dostępna w ramach programu wersji przedpremierowej dla programistów Google Workspace, który zapewnia wcześniejszy dostęp do niektórych funkcji.

W wersji zapoznawczej dla deweloperów możesz asynchronicznie aktualizować karty w wiadomości za pomocą metody.replaceCards Jest to przydatne do aktualizowania zawartości karty bez interakcji z użytkownikiem, np. do odświeżania podglądu linku lub aktualizowania stanu zadania. Ta metoda działa w przypadku wiadomości utworzonych przez aplikację, w tym tych utworzonych w imieniu użytkownika.

Szczegółowe informacje znajdziesz w artykule Tworzenie i aktualizowanie kart.

Powiązane artykuły

• Formatowanie wiadomości.
• Usuwanie wiadomości.
• Uzyskiwanie szczegółowych informacji o wiadomości.
• Wyświetlanie listy wiadomości w pokoju.
• Wysyłanie wiadomości.
• Wyszukiwanie wiadomości.