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

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

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

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

Node.js

  • حساب Google Workspace للعمل أو للمؤسسة مع إمكانية الوصول إلى Google Chat.

Python

  • حساب Google Workspace للعمل أو للمؤسسة مع إمكانية الوصول إلى Google Chat.

جافا

  • حساب Google Workspace للعمل أو للمؤسسة مع إمكانية الوصول إلى Google Chat.

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

  • حساب Google Workspace للعمل أو للمؤسسة مع إمكانية الوصول إلى Google Chat.

سرد الرسائل كمستخدم

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

  • حدِّد نطاق تفويض 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);
  }
}

await main();

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()

جافا

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) {
      for (const message of responsePage.messages) {
        console.log(message);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

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

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

سرد الرسائل كتطبيق Chat

تتطلب مصادقة التطبيق موافقة المشرف لمرة واحدة .

لسرد الرسائل من مساحة باستخدام مصادقة التطبيق وChat REST API، مرِّر ما يلي في طلبك:

  • حدِّد أحد نطاقات التفويض التالية:
    • https://www.googleapis.com/auth/chat.app.messages.readonly
  • استدعِ طريقة list في مورد messages.
  • مرِّر name للمساحة التي تريد سرد الرسائل منها.

كتابة نص برمجي يستدعي Chat API

إليك كيفية سرد الرسائل باستخدام مصادقة التطبيق و Chat REST API:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم chat_messages_list_app.py.

  2. أدرِج الرمز البرمجي التالي في chat_messages_list_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 lists messages from a specified space.
    '''

    # 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().list(

        # The space to list messages from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE_NAME'

    ).execute()

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

if __name__ == '__main__':
    main()

  3. في الرمز البرمجي، استبدِل ما يلي:

    • SPACE_NAME: اسم مساحة، يمكنك الحصول عليه من طريقة spaces.list في Chat API أو من عنوان URL لمساحة

  4. في دليل العمل، أنشِئ النموذج وشغِّله:

    python3 chat_messages_list_app.py

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