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

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

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

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

Node.js

  • आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.

Python

  • आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.

Java

  • आपके पास Business या Enterprise वर्शन वाला Google Workspace खाता होना चाहिए. साथ ही, आपके पास Google Chat को ऐक्सेस करने की अनुमति होनी चाहिए.

Apps Script

  • आपके पास Business या Enterprise वर्शन वाला 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);
  }
}

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

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) {
      responsePage.messages.forEach((message) => 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 का इस्तेमाल करके, ऐप्लिकेशन की पुष्टि वाले स्पेस से मैसेज की सूची पाने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

  • इनमें से कोई एक अनुमति का दायरा तय करें:
    • https://www.googleapis.com/auth/chat.app.messages.readonly
  • messages संसाधन पर list तरीके को कॉल करें.
  • जिस स्पेस के मैसेज की सूची बनानी है उसका name पास करें.

एपीआई पासकोड बनाना

डेवलपर प्रीव्यू एपीआई के तरीके को कॉल करने के लिए, आपको एपीआई डिस्कवरी दस्तावेज़ के डेवलपर प्रीव्यू वर्शन का इस्तेमाल करना होगा. यह वर्शन सार्वजनिक नहीं होता. अनुरोध की पुष्टि करने के लिए, आपको एपीआई पासकोड डालना होगा.

एपीआई पासकोड बनाने के लिए, अपने ऐप्लिकेशन का Google Cloud प्रोजेक्ट खोलें और यह तरीका अपनाएं:

  1. Google Cloud console में, मेन्यू > एपीआई और सेवाएं > क्रेडेंशियल पर जाएं.

    क्रेडेंशियल पर जाएं

  2. क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करें.
  3. आपको नई एपीआई कुंजी दिखेगी.
    • अपने ऐप्लिकेशन के कोड में इस्तेमाल करने के लिए, एपीआई पासकोड कॉपी करने के लिए, कॉपी करें पर क्लिक करें. एपीआई कुंजी, आपके प्रोजेक्ट के क्रेडेंशियल के "एपीआई कुंजियां" सेक्शन में भी देखी जा सकती है.
    • हमारा सुझाव है कि बिना अनुमति के इस्तेमाल को रोकने के लिए, यह तय करें कि एपीआई कुंजी का इस्तेमाल कहां और किन एपीआई के लिए किया जा सकता है. ज़्यादा जानकारी के लिए, एपीआई पर पाबंदियां जोड़ना लेख पढ़ें.

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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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. कोड में, इनकी जगह ये डालें:

    • API_KEY: वह एपीआई पासकोड जिसे आपने Chat API के लिए सर्विस एंडपॉइंट बनाने के लिए बनाया है.

    • SPACE_NAME: स्पेस का नाम. इसे Chat API में spaces.list तरीके से या स्पेस के यूआरएल से पाया जा सकता है.

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

    python3 chat_messages_list_app.py

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