ดูรายละเอียดเกี่ยวกับข้อความ

คู่มือนี้อธิบายวิธีใช้ get() เมธอดในทรัพยากร Message ของ Google Chat API เพื่อแสดงรายละเอียดเกี่ยวกับข้อความที่เป็น ข้อความหรือการ์ด

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

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

Node.js

Python

Java

Apps Script

รับข้อความด้วยการตรวจสอบสิทธิ์ของผู้ใช้

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

  • ระบุขอบเขตการให้สิทธิ์ chat.messages.readonly หรือ chat.messages
  • เรียกใช้เมธอด GetMessage()
  • ตั้งค่า name เป็นชื่อทรัพยากรของข้อความที่จะรับ

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

Node.js

chat/client-libraries/cloud/get-message-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
  };

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

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

await main();

Python

chat/client-libraries/cloud/get_message_user_cred.py
from authentication_utils import create_client_with_user_credentials
import google.oauth2.credentials

from google.apps import chat_v1 as google_chat

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

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

    # Initialize request argument(s)
    request = google_chat.GetMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

get_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMessageUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMessageRequest;
import com.google.chat.v1.Message;

// This sample shows how to get message with user credential.
public class GetMessageUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetMessageRequest.Builder request = GetMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/members/MESSAGE_NAME");
      Message response = chatServiceClient.getMessage(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get message with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = "spaces/SPACE_NAME/messages/MESSAGE_NAME";

  // Make the request
  const response = Chat.Spaces.Messages.get(name);

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

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

  • SPACE_NAME: รหัสจาก name ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจาก name ของข้อความ คุณรับรหัสได้จากเนื้อหาการตอบกลับที่ส่งคืนหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือจาก ชื่อที่กำหนดเอง ที่กำหนดให้กับข้อความเมื่อสร้าง

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

รับข้อความด้วยการตรวจสอบสิทธิ์ของแอป

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

  • ระบุขอบเขตการให้สิทธิ์ ตัวอย่างในส่วนนี้ใช้ขอบเขต chat.bot ซึ่งพร้อมใช้งานโดยทั่วไปและไม่ต้องได้รับการอนุมัติจากผู้ดูแลระบบ หรือคุณจะให้สิทธิ์ในฐานะแอป Chat โดยได้รับการอนุมัติจากผู้ดูแลระบบก็ได้
  • เรียกใช้เมธอด GetMessage()
  • ตั้งค่า name เป็นชื่อทรัพยากรของข้อความที่จะรับ

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

Node.js

chat/client-libraries/cloud/get-message-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
  };

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

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

await main();

Python

chat/client-libraries/cloud/get_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 get message with app credential
def get_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
    )

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

    # Handle the response
    print(response)

get_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetMessageAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetMessageRequest;
import com.google.chat.v1.Message;

// This sample shows how to get message with app credential.
public class GetMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetMessageRequest.Builder request = GetMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/members/MESSAGE_NAME");
      Message response = chatServiceClient.getMessage(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to get message with app credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = "spaces/SPACE_NAME/messages/MESSAGE_NAME";
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Messages.get(
    name,
    parameters,
    getHeaderWithAppCredentials(),
  );

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

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

  • SPACE_NAME: รหัสจาก name ของพื้นที่ทำงาน คุณรับรหัสได้โดยเรียกใช้เมธอด ListSpaces() หรือจาก URL ของพื้นที่ทำงาน
  • MESSAGE_NAME: รหัสจาก name ของข้อความ คุณรับรหัสได้จากเนื้อหาการตอบกลับที่ส่งคืนหลังจากสร้างข้อความแบบไม่พร้อมกันด้วย Chat API หรือจาก ชื่อที่กำหนดเอง ที่กำหนดให้กับข้อความเมื่อสร้าง

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

รับข้อความในฐานะแอป Chat โดยได้รับการอนุมัติจากผู้ดูแลระบบ

การตรวจสอบสิทธิ์ของแอปที่มีขอบเขตการให้สิทธิ์ chat.app.* ต้องได้รับการอนุมัติจากผู้ดูแลระบบเพียงครั้งเดียว

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

  • เรียกใช้เมธอด GetMessage()
  • ระบุขอบเขตการให้สิทธิ์ chat.app.messages.readonly
  • ตั้งค่า name เป็นชื่อทรัพยากรของข้อความที่จะรับ

เขียนสคริปต์ที่เรียกใช้ Chat API

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

Python

  1. สร้างไฟล์ชื่อ chat_messages_get_admin_app.py ในไดเรกทอรีงาน

  2. ใส่โค้ดต่อไปนี้ใน chat_messages_get_admin_app.py

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.messages.readonly"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then gets details about a message.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().get(

        # The message to get details about.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/messages/MESSAGE_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. ในโค้ด ให้แทนที่ข้อมูลต่อไปนี้

  4. สร้างและเรียกใช้ตัวอย่างในไดเรกทอรีงานโดยทำดังนี้

    python3 chat_messages_get_admin_app.py

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