อัปเดตข้อความ

คู่มือนี้จะอธิบายถึงวิธีใช้ update() ในทรัพยากร Message ของ Google Chat API เพื่ออัปเดตข้อความหรือการ์ด ข้อความในพื้นที่ทำงาน อัปเดตข้อความเพื่อเปลี่ยนแอตทริบิวต์ข้อความ เช่น ข้อความที่แสดงหรือเนื้อหาของการ์ด นอกจากนี้คุณยังเพิ่ม SMS ไว้ด้านหน้า ข้อความการ์ด หรือเพิ่มการ์ดต่อท้ายข้อความ

ใน Chat API ข้อความ Chat จะแสดงโดยทรัพยากร Message แม้ว่าผู้ใช้ Chat จะส่งได้เฉพาะข้อความที่มีข้อความ แต่แอป Chat สามารถใช้ฟีเจอร์การรับส่งข้อความอื่นๆ อีกมากมาย ซึ่งรวมถึงการแสดงอินเทอร์เฟซผู้ใช้แบบคงที่หรือแบบอินเทอร์แอกทีฟ การเก็บรวบรวมข้อมูลจากผู้ใช้ และการนำส่งข้อความแบบส่วนตัว ดูข้อมูลเพิ่มเติมเกี่ยวกับฟีเจอร์การรับส่งข้อความที่ใช้ได้กับ Chat API ได้ที่ภาพรวมข้อความของ Google Chat

ข้อกำหนดเบื้องต้น

Node.js

  • ธุรกิจหรือองค์กร บัญชี Google Workspace ที่มีสิทธิ์เข้าถึง Google Chat

Python

  • บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

Java

  • บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

Apps Script

  • บัญชี Google Workspace รุ่น Business หรือ Enterprise ที่มีสิทธิ์เข้าถึง Google Chat

อัปเดตข้อความในนามของผู้ใช้

เมื่อใช้การตรวจสอบสิทธิ์ผู้ใช้ คุณจะอัปเดตได้เฉพาะข้อความของข้อความเท่านั้น

หากต้องการอัปเดตข้อความด้วยการตรวจสอบสิทธิ์ผู้ใช้ ให้ส่งข้อมูลต่อไปนี้ใน คำขอ:

  • ระบุขอบเขตการให้สิทธิ์ chat.messages
  • เรียกใช้เมธอด UpdateMessage()
  • ส่ง message เป็นอินสแตนซ์ของ Message พร้อมข้อมูลต่อไปนี้
    • ฟิลด์ name ตั้งค่าเป็นข้อความที่จะอัปเดต ซึ่งประกอบด้วยรหัสพื้นที่ทำงานและรหัสข้อความ
    • ตั้งค่าช่อง text ด้วยข้อความใหม่แล้ว
  • ส่ง updateMask ที่มีค่า text

หากข้อความที่อัปเดตเป็น ข้อความในการ์ด ข้อความจะเพิ่มไว้ข้างหน้าการ์ด (ซึ่งจะแสดงต่อไป)

วิธีอัปเดตข้อความหรือใส่ข้อความ SMS ไว้หน้าข้อความของการ์ดที่มีการตรวจสอบสิทธิ์ผู้ใช้มีดังนี้

Node.js

chat/client-libraries/cloud/update-message-user-cred.js
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
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
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
/**
 * 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 ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจากname ของข้อความ คุณดูรหัสได้จากเนื้อหาการตอบกลับที่แสดงผลหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือชื่อที่กำหนดเองที่กำหนดให้กับข้อความเมื่อสร้าง

Chat API จะแสดงผลอินสแตนซ์ของ Message ที่แสดงรายละเอียดข้อความที่อัปเดต

อัปเดตข้อความเป็นแอป Chat

เมื่อใช้การตรวจสอบสิทธิ์แอป คุณจะอัปเดตทั้งข้อความและการ์ดของข้อความได้

หากต้องการอัปเดตข้อความด้วยการตรวจสอบสิทธิ์ของแอป ให้ส่งข้อมูลต่อไปนี้ในคำขอ

  • ระบุขอบเขตการให้สิทธิ์ chat.bot
  • เรียกใช้ UpdateMessage()
  • ส่ง message เป็นอินสแตนซ์ของ Message พร้อมข้อมูลต่อไปนี้
    • ช่อง name ที่ตั้งค่าเป็นข้อความที่จะอัปเดต ซึ่งมีรหัสพื้นที่ทำงาน และรหัสข้อความ
    • ช่อง text ที่ตั้งค่าด้วยข้อความใหม่หากจำเป็นต้องอัปเดต
    • ฟิลด์ cardsV2 ที่ตั้งค่าไว้กับการ์ดใหม่หากต้องมีการอัปเดต
  • ส่ง updateMask พร้อมรายการช่องที่ต้องอัปเดต เช่น text และ cardsV2

หากข้อความที่อัปเดตเป็น ข้อความในการ์ด ข้อความที่อัปเดตจะเพิ่มไว้ข้างหน้าการ์ด (ซึ่งจะแสดงต่อไป) หากข้อความที่อัปเดตเป็น ข้อความและการ์ด จากนั้นการ์ดที่อัปเดตจะต่อท้ายข้อความ (ซึ่งต่อเนื่องไปยัง จอแสดงผล)

ต่อไปนี้เป็นวิธีอัปเดตข้อความและการ์ดของข้อความด้วย การตรวจสอบสิทธิ์แอป:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js
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
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
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
/**
 * 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 คุณสามารถรับรหัสโดยโทรไปที่ ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจาก name คุณดูรหัสได้จากเนื้อหาการตอบกลับที่แสดงผลหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือชื่อที่กำหนดเองที่กำหนดให้กับข้อความเมื่อสร้าง

Chat API จะแสดงผลอินสแตนซ์ Message ซึ่งแสดงรายละเอียดข้อความที่ได้รับการอัปเดต