إدراج الرسائل

يشرح هذا الدليل كيفية استخدام list() على المورد Message في Google Chat API للاطّلاع على جدول بيانات قائمة قابلة للفلترة تضم رسائل في إحدى المساحات

في Chat API، يتم تمثيل رسالة Chat باستخدام موارد Message. يمكن لمستخدمي Chat إرسال الرسائل التي تحتوي على نصوص فقط، يمكن لتطبيقات Chat استخدام العديد من ميزات المراسلة الأخرى، بما في ذلك تعرض واجهات مستخدم ثابتة أو تفاعلية، تجمع المعلومات من والمستخدمين، وتسليم الرسائل بشكل خاص. لمزيد من المعلومات حول ميزات المراسلة المتوفّرة لواجهة برمجة تطبيقات Chat، يُرجى الاطّلاع على مقالة نظرة عامة على رسائل Google Chat.

المتطلبات الأساسية

Node.js

Python

Java

برمجة تطبيقات

إدراج الرسائل

لإدراج الرسائل باستخدام مصادقة المستخدم، قم بتمرير ما يلي في طلبك:

  • حدِّد نطاق التفويض chat.messages.readonly أو chat.messages.
  • عليك استدعاء ListMessages() .

يعرض المثال التالي الرسائل في "مساحة Chat":

Node.js

chat/client-libraries/cloud/list-messages-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 list messages 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 here
    parent: 'spaces/SPACE_NAME'
  };

  // Make the request
  const pageResult = chatClient.listMessagesAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

Python

chat/client-libraries/cloud/list_messages_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.readonly"]

# This sample shows how to list messages with user credential
def list_messages_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.ListMessagesRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_messages(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_messages_with_user_cred()

Java

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

// This sample shows how to list messages with user credential.
public class ListMessagesUserCred {

  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))) {
      ListMessagesRequest.Builder request = ListMessagesRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterate over results and resolve additional pages automatically.
      for (Message response :
          chatServiceClient.listMessages(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

برمجة تطبيقات

chat/advanced-service/Main.gs
/**
 * This sample shows how to list messages 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 listMessagesUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = 'spaces/SPACE_NAME';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Messages.list(parent, {
      pageSize: 10,
      pageToken: pageToken
    });
    // Handle response pages
    if (responsePage.messages) {
      responsePage.messages.forEach((message) => console.log(message));
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

لتنفيذ هذا النموذج، استبدِل SPACE_NAME برقم التعريف من المساحة الإعلانية name . يمكنك الحصول على المعرّف من خلال استدعاء الأسلوب ListSpaces() أو من عنوان URL للمساحة.

تعرض واجهة برمجة تطبيقات Chat قائمة الرسائل إرسالها في المساحة المحددة. في حال عدم وجود رسائل من الطلب، سيتم يعرض ردّ واجهة برمجة التطبيقات Chat عنصرًا فارغًا. عند استخدام REST/HTTP تحتوي الاستجابة على كائن JSON فارغ، {}.