स्पेस के सदस्यों की सूची बनाना

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

  • ऐप्लिकेशन की पुष्टि करने के बाद, सदस्यताओं की सूची में उन स्पेस की सदस्यताएं दिखती हैं जिनका ऐक्सेस Chat ऐप्लिकेशन के पास है. हालांकि, इसमें Chat ऐप्लिकेशन की सदस्यताएं शामिल नहीं होतीं.
  • उपयोगकर्ता की पुष्टि करने के बाद, सदस्यताओं की सूची में उन स्पेस की सदस्यताएं दिखती हैं जिनका ऐक्सेस पुष्टि किए गए उपयोगकर्ता के पास है.
  • एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करने के बाद, Google Workspace एडमिन के तौर पर सदस्यताएं जोड़ने पर, आपके Google Workspace संगठन के सभी स्पेस में सदस्यताएं दिखती हैं.

Membership रिसॉर्स से पता चलता है कि किसी व्यक्ति या Google Chat ऐप्लिकेशन को स्पेस में शामिल होने का न्योता मिला है या नहीं. साथ ही, यह भी पता चलता है कि वह व्यक्ति या ऐप्लिकेशन स्पेस में शामिल है या नहीं.

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

Node.js

  • आपके पास Google Chat का ऐक्सेस हो और आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो.

Python

  • आपके पास Google Chat का ऐक्सेस हो और आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो.

Java

  • आपके पास Google Chat का ऐक्सेस हो और आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो.

Apps Script

  • आपके पास Google Chat का ऐक्सेस हो और आपके पास Google Workspace का Business या Enterprise वर्शन वाला खाता हो.

उपयोगकर्ता की पुष्टि करने के बाद, स्पेस में शामिल सदस्यों की सूची देखना

पुष्टि किए गए उपयोगकर्ता के पास जिस स्पेस का ऐक्सेस है उसमें उपयोगकर्ताओं, Google Groups, और Chat ऐप्लिकेशन की सूची बनाने के लिए, अपने अनुरोध में ये चीज़ें शामिल करें:

  • उपयोगकर्ता की पुष्टि के लिए, अनुमति के chat.memberships.readonly या chat.memberships दायरे की जानकारी दें.
  • ListMemberships() वाला तरीका कॉल करें.
  • Google ग्रुप की सूची देखने के लिए, क्वेरी पैरामीटर showGroups को true पर सेट करें.

यहां दिए गए उदाहरण में, Google ग्रुप, मानव, और ऐप्लिकेशन के उन सदस्यों की सूची दी गई है जो पुष्टि किए गए उपयोगकर्ता को दिखते हैं.

Node.js

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

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

// This sample shows how to list memberships 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',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"'
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(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_memberships_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.memberships.readonly"]

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

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

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

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

list_memberships_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with user credential.
public class ListMembershipsUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listMembershipsUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = 'spaces/SPACE_NAME';
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

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

इस सैंपल को चलाने के लिए, SPACE_NAME को स्पेस के name फ़ील्ड से मिले आईडी से बदलें. आईडी पाने के लिए, ListSpaces() तरीका अपनाएं या स्पेस के यूआरएल का इस्तेमाल करें.

Google Chat API, दिए गए स्पेस में मौजूद Google ग्रुप, लोगों, और ऐप्लिकेशन के सदस्यों की सूची दिखाता है.

ऐप्लिकेशन से पुष्टि करने की सुविधा वाले स्पेस में सदस्यों की सूची देखना

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

  • ऐप्लिकेशन की पुष्टि के लिए, chat.bot अनुमति का दायरा तय करें.
  • ListMemberships() वाला तरीका कॉल करें.
  • Google ग्रुप की सूची देखने के लिए, क्वेरी पैरामीटर showGroups को true पर सेट करें.

यहां दिए गए उदाहरण में, Chat ऐप्लिकेशन में दिखने वाले स्पेस के उन सदस्यों की सूची दी गई है जो स्पेस मैनेजर नहीं हैं:

Node.js

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

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
    // ROLE_MANAGER)
    filter: 'member.type = "HUMAN"'
  };

  // Make the request
  const pageResult = chatClient.listMembershipsAsync(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_memberships_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 list memberships with app credential
def list_memberships_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.ListMembershipsRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
        # ROLE_MANAGER)
        filter = 'member.type = "HUMAN"',
        # Number of results that will be returned at once
        page_size = 100
    )

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

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

list_memberships_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMembershipsAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMembershipsRequest;
import com.google.chat.v1.ListMembershipsResponse;
import com.google.chat.v1.Membership;

// This sample shows how to list memberships with app credential.
public class ListMembershipsAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      ListMembershipsRequest.Builder request = ListMembershipsRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Filter membership by type (HUMAN or BOT) or role
        // (ROLE_MEMBER or ROLE_MANAGER).
        .setFilter("member.type = \"HUMAN\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list memberships with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function listMembershipsAppCred() {
// Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = 'spaces/SPACE_NAME';
  // Filter membership by type (HUMAN or BOT) or role (ROLE_MEMBER or
  // ROLE_MANAGER)
  const filter = 'member.type = "HUMAN"';

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

इस सैंपल को चलाने के लिए, SPACE_NAME को स्पेस के name फ़ील्ड से मिले आईडी से बदलें. आईडी पाने के लिए, ListSpaces() तरीका अपनाएं या स्पेस के यूआरएल का इस्तेमाल करें.

Google Chat API, दिए गए स्पेस के उन सदस्यों की सूची दिखाता है जो स्पेस मैनेजर नहीं हैं.

Google Workspace एडमिन के तौर पर सदस्यों की सूची बनाना

अगर आप Google Workspace एडमिन हैं, तो अपने Google Workspace संगठन के किसी भी स्पेस की सदस्यताओं की सूची देखने के लिए, ListMemberships() तरीका अपनाएं. Chat API, आपके संगठन के उपयोगकर्ताओं या Google ग्रुप की सदस्यता की जानकारी ही दिखाता है. इसमें संगठन के बाहर के उपयोगकर्ताओं की सदस्यता की जानकारी शामिल नहीं होती.

Google Workspace एडमिन के तौर पर, इस तरीके को कॉल करने के लिए यह तरीका अपनाएं:

  • उपयोगकर्ता की पुष्टि करने के तरीके का इस्तेमाल करके, उस तरीके को कॉल करें. साथ ही, ऐसा अनुमति का दायरा तय करें जिससे एडमिन के अधिकारों का इस्तेमाल करके, उस तरीके को कॉल किया जा सके.
  • अपने अनुरोध में, ये क्वेरी पैरामीटर शामिल करें:
    • useAdminAccess को true पर सेट करें.
    • सिर्फ़ उपयोगकर्ताओं की जानकारी दिखाने के लिए, member.type के लिए filter को HUMAN पर सेट करें.
    • उपयोगकर्ताओं और ग्रुप को वापस लाने के लिए, member.type के लिए filter को BOT के बराबर न सेट करें AND showGroups को true के बराबर सेट करें.

ज़्यादा जानकारी और उदाहरणों के लिए, Google Workspace एडमिन के तौर पर, Google Chat के स्पेस मैनेज करना लेख पढ़ें.

पेजेशन को पसंद के मुताबिक बनाना या सूची को फ़िल्टर करना

पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची देखने के लिए, नीचे दिए गए क्वेरी पैरामीटर पास करें. इससे, पैसे चुकाकर ली जाने वाली सदस्यताओं की सूची को पसंद के मुताबिक बनाया जा सकता है या उन्हें फ़िल्टर किया जा सकता है:

  • pageSize: सदस्यताओं की ज़्यादा से ज़्यादा संख्या. ऐसा हो सकता है कि सेवा, इस वैल्यू से कम डेटा दिखाए. अगर कोई वैल्यू नहीं दी जाती है, तो ज़्यादा से ज़्यादा 100 स्पेस दिखाए जाते हैं. ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है. 1,000 से ज़्यादा वैल्यू होने पर, वे अपने-आप 1,000 हो जाती हैं.
  • pageToken: पेज टोकन, जो सूची वाले स्पेस के पिछले कॉल से मिला है. अगला पेज देखने के लिए, यह टोकन दें. पेजेशन करते समय, फ़िल्टर की वैल्यू उस कॉल से मेल खानी चाहिए जिसने पेज टोकन दिया है. कोई दूसरी वैल्यू देने पर, अनचाहे नतीजे मिल सकते हैं.
  • filter: क्वेरी फ़िल्टर. इसके लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है. काम करने वाली क्वेरी की जानकारी के लिए, ListMembershipsRequest रेफ़रंस देखें.