このページは Cloud Translation API によって翻訳されました。

メッセージを更新する

このガイドでは、Google Chat API の Message リソースで update() メソッドを使用して、スペース内のテキストメッセージまたはカードメッセージを更新する方法について説明します。メッセージを更新して、メッセージの属性（メッセージの内容やカードのコンテンツなど）を変更します。テキストメッセージをカードメッセージの先頭に追加したり、カードをテキストメッセージの末尾に追加したりすることもできます。

Chat API では、Chat メッセージは Message リソースで表されます。Chat ユーザーはテキストを含むメッセージのみを送信できますが、Chat 用アプリは、静的またはインタラクティブなユーザーインターフェースの表示、ユーザーからの情報の収集、メッセージの非公開配信など、他の多くのメッセージ機能を使用できます。Chat API で使用できるメッセージ機能の詳細については、Google Chat メッセージの概要をご覧ください。

前提条件

Node.js

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する。
- Chat 用アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Node.js Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいて、アクセス認証情報を作成します。
  - Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat 用アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとして保存します。
ユーザーとして認証するか、Chat 用アプリとして認証するかに基づいて、認証スコープを選択します。

Python

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する。
- Chat 用アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Python Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいて、アクセス認証情報を作成します。
  - Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat 用アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとして保存します。
ユーザーとして認証するか、Chat 用アプリとして認証するかに基づいて、認証スコープを選択します。

Java

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する。
- Chat 用アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Java Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいて、アクセス認証情報を作成します。
  - Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat 用アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.json という名前の JSON ファイルとして保存します。
ユーザーとして認証するか、Chat 用アプリとして認証するかに基づいて、認証スコープを選択します。

Apps Script

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する。
- Chat 用アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- スタンドアロンの Apps Script プロジェクトを作成し、高度な Chat サービスを有効にします。
- このガイドでは、ユーザー認証またはアプリ認証のいずれかを使用する必要があります。Chat 用アプリとして認証するには、サービスアカウントの認証情報を作成します。手順については、Google Chat アプリとして認証と認可を行うをご覧ください。
ユーザーとして認証するか、Chat 用アプリとして認証するかに基づいて、認証スコープを選択します。

ユーザーに代わってメッセージを更新する

ユーザー認証では、メッセージのテキストのみを更新できます。

ユーザー認証を使用してメッセージを更新するには、リクエストで次の情報を渡します。

chat.messages 認可スコープを指定します。
UpdateMessage() メソッドを呼び出します。
次のコードを使用して、message を Message のインスタンスとして渡します。
- 更新するメッセージに設定された name フィールド。スペース ID とメッセージ ID が含まれます。
- 新しいテキストが設定された text フィールド。
値 text を含む updateMask を渡します。

更新されたメッセージがカードメッセージの場合、テキストはカードの先頭に追加されます（カードは引き続き表示されます）。

ユーザー認証を使用してメッセージを更新したり、カードメッセージにテキストメッセージを追加したりする方法は次のとおりです。

Node.js

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

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

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

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

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

このサンプルを実行するには、次の値を置き換えます。

SPACE_NAME: スペースの name からの ID。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
MESSAGE_NAME: メッセージの name からの ID。この ID は、Chat API を使用してメッセージを非同期で作成した後に返されるレスポンス本文から取得するか、作成時にメッセージに割り当てられたカスタム名から取得できます。

Chat API は、更新されたメッセージの詳細を示す Message のインスタンスを返します。

Chat 用アプリとしてメッセージを更新する

アプリ認証を使用すると、メッセージのテキストとカードの両方を更新できます。

アプリ認証でメッセージを更新するには、リクエストで次の情報を渡します。

chat.bot 認可スコープを指定します。
UpdateMessage() メソッドを呼び出します。
次のコードを使用して、message を Message のインスタンスとして渡します。
- 更新するメッセージに設定された name フィールド。スペース ID とメッセージ ID が含まれます。
- 更新が必要な場合は、新しいテキストで設定された text フィールド。
- 更新が必要な場合は、新しいカードで設定された cardsV2 フィールド。
updateMask にフィールドのリストを渡して、text や cardsV2 などの更新を行います。

更新されたメッセージがカードメッセージで、テキストが更新された場合、更新されたテキストはカードの先頭に追加されます（カードは引き続き表示されます）。更新されたメッセージがテキストメッセージで、カードが更新された場合、更新されたカードはテキストに追加されます（テキストは引き続き表示されます）。

アプリ認証を使用してメッセージのテキストとカードを更新する方法は次のとおりです。

Node.js

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

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

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

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

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

このサンプルを実行するには、次の値を置き換えます。

SPACE_NAME: スペースの name からの ID。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
MESSAGE_NAME: メッセージの name からの ID。この ID は、Chat API を使用してメッセージを非同期で作成した後に返されるレスポンス本文から取得するか、作成時にメッセージに割り当てられたカスタム名から取得できます。

Chat API は、更新されたメッセージの詳細を示す Message のインスタンスを返します。

メッセージを更新する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件

Node.js

Python

Java

Apps Script

ユーザーに代わってメッセージを更新する

Node.js

Python

Java

Apps Script

Chat 用アプリとしてメッセージを更新する

Node.js

Python

Java

Apps Script

関連トピック

メッセージを更新する