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

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

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

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

Node.js

Python

Java

Apps Script

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

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

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

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

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

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

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

await main();

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

หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ข้อมูลต่อไปนี้

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

await main();

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

หากต้องการเรียกใช้ตัวอย่างนี้ ให้แทนที่ข้อมูลต่อไปนี้

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

อัปเดตการ์ดแบบไม่พร้อมกัน

ใน เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์ คุณสามารถ อัปเดตการ์ดในข้อความแบบไม่พร้อมกันได้โดยใช้ replaceCards เมธอด ซึ่งมีประโยชน์สำหรับการอัปเดตเนื้อหาของการ์ดโดยไม่ต้องให้ผู้ใช้โต้ตอบ เช่น การรีเฟรชการแสดงตัวอย่างลิงก์หรือการอัปเดตสถานะของงาน เมธอดนี้ใช้ได้กับข้อความที่แอปสร้างขึ้น รวมถึงข้อความที่สร้างขึ้นในนามของผู้ใช้

ดูรายละเอียดได้ที่หัวข้อ สร้างและอัปเดตการ์ด