मैसेज की सूची बनाना

इस गाइड में, Google Chat API के Message संसाधन पर list() तरीके का इस्तेमाल करके, किसी स्पेस में मौजूद मैसेज की पेज के हिसाब से फ़िल्टर की जा सकने वाली सूची देखने का तरीका बताया गया है.

Chat API में, Chat पर भेजे गए मैसेज को Message संसाधन के तौर पर दिखाया जाता है. Chat के उपयोगकर्ता सिर्फ़ टेक्स्ट वाले मैसेज भेज सकते हैं. हालांकि, Chat ऐप्लिकेशन, मैसेजिंग की कई अन्य सुविधाओं का इस्तेमाल कर सकते हैं. इनमें स्टैटिक या इंटरैक्टिव यूज़र इंटरफ़ेस (यूआई) दिखाना, उपयोगकर्ताओं से जानकारी इकट्ठा करना, और निजी तौर पर मैसेज भेजना शामिल है. Chat API के लिए उपलब्ध मैसेजिंग की सुविधाओं के बारे में ज़्यादा जानने के लिए, Google Chat पर भेजे गए मैसेज की खास जानकारी देखें.

ज़रूरी शर्तें

Node.js

  • कारोबार या एंटरप्राइज़ के लिए Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.

Python

  • कारोबार या एंटरप्राइज़ के लिए Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.

Java

  • कारोबार या एंटरप्राइज़ के लिए Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.

Apps Script

  • कारोबार या एंटरप्राइज़ के लिए Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.

उपयोगकर्ता के तौर पर मैसेज की सूची देखना

उपयोगकर्ता की पुष्टि के साथ मैसेज की सूची देखने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

यहां दिए गए उदाहरण में, 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()

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

Apps Script

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() तरीके को कॉल करें या स्पेस के यूआरएल से आईडी पाएं.

Chat API, तय किए गए स्पेस में भेजे गए मैसेज की सूची दिखाता है. अगर अनुरोध में कोई मैसेज नहीं है, तो Chat API का जवाब एक खाली ऑब्जेक्ट दिखाता है. REST/HTTP इंटरफ़ेस का इस्तेमाल करने पर, जवाब में एक खाली JSON ऑब्जेक्ट, {} शामिल होता है.

Chat ऐप्लिकेशन के तौर पर मैसेज की सूची देखना

ऐप्लिकेशन की पुष्टि के लिए, एडमिन की एक बार अनुमति लेना ज़रूरी है .

Chat REST API का इस्तेमाल करके, ऐप्लिकेशन की पुष्टि के साथ किसी स्पेस में भेजे गए मैसेज की सूची देखने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

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: स्पेस का नाम. इसे Chat API में spaces.list तरीके से या किसी स्पेस के यूआरएल से पाया जा सकता है.

  4. अपनी वर्किंग डायरेक्ट्री में, नमूना बनाएं और चलाएं:

    python3 chat_messages_list_app.py

Chat API, तय किए गए स्पेस में भेजे गए मैसेज की सूची दिखाता है. अगर अनुरोध में कोई मैसेज नहीं है, तो Chat API का जवाब एक खाली ऑब्जेक्ट दिखाता है. REST/HTTP इंटरफ़ेस का इस्तेमाल करने पर, जवाब में एक खाली JSON ऑब्जेक्ट, {} शामिल होता है.