स्पेस की सूची बनाएं

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

स्पेस के मालिक और मैनेजर, यह पाबंदी लगा सकते हैं कि स्पेस में सदस्यों की सूची किसे दिखे.

Space संसाधन एक ऐसी जगह होती है जहां लोग और Chat ऐप्लिकेशन, मैसेज भेज सकते हैं, फ़ाइलें शेयर कर सकते हैं, और साथ मिलकर काम कर सकते हैं. स्पेस कई तरह के होते हैं:

  • डायरेक्ट मैसेज (डीएम), दो उपयोगकर्ताओं या किसी उपयोगकर्ता और Chat ऐप्लिकेशन के बीच की बातचीत होती है.
  • ग्रुप चैट, तीन या उससे ज़्यादा उपयोगकर्ताओं और Chat ऐप्लिकेशन के बीच होने वाली बातचीत होती है.
  • नाम वाले स्पेस, ऐसी जगहें होती हैं जहां लोग मैसेज भेजते हैं, फ़ाइलें शेयर करते हैं, और साथ मिलकर काम करते हैं.

ऐप्लिकेशन की पुष्टि की सुविधा वाले स्पेस की सूची में, वे स्पेस दिखते हैं जिन्हें 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 का ऐक्सेस हो.

उपयोगकर्ता की पुष्टि करने की सुविधा वाले स्पेस की सूची

Google Chat में मौजूद स्पेस की सूची पाने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

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

Node.js

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

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

// This sample shows how to list spaces with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
    filter: 'space_type = "SPACE"',
  };

  // Make the request
  const pageResult = chatClient.listSpacesAsync(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_spaces_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.spaces.readonly"]

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

    # Initialize request argument(s)
    request = google_chat.ListSpacesRequest(
        # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
        filter = 'space_type = "SPACE"',
        # Number of results that will be returned at once
        page_size = 100
    )

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

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

list_spaces_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListSpacesUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListSpacesRequest;
import com.google.chat.v1.ListSpacesResponse;
import com.google.chat.v1.Space;

// This sample shows how to list spaces with user credential.
public class ListSpacesUserCred{

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      ListSpacesRequest.Builder request = ListSpacesRequest.newBuilder()
        // Filter spaces by space type (SPACE or GROUP_CHAT or
        // DIRECT_MESSAGE).
        .setFilter("spaceType = \"SPACE\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpacesUserCred() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageSize: 10,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Chat API, स्पेस की पेज के हिसाब से बांटी गई सूची दिखाता है.

ऐप्लिकेशन की पुष्टि करने की सुविधा वाले स्पेस की सूची

Google Chat में स्पेस की सूची बनाने के लिए, अपने अनुरोध में यह जानकारी शामिल करें:

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

Node.js

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

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

  // Initialize request argument(s)
  const request = {
    // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
    filter: 'space_type = "SPACE"',
  };

  // Make the request
  const pageResult = chatClient.listSpacesAsync(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_spaces_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 spaces with app credential
def list_spaces_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.ListSpacesRequest(
        # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
        filter = 'space_type = "SPACE"',
        # Number of results that will be returned at once
        page_size = 100
    )

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

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

list_spaces_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListSpacesAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListSpacesRequest;
import com.google.chat.v1.ListSpacesResponse;
import com.google.chat.v1.Space;

// This sample shows how to list spaces with app credential.
public class ListSpacesAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      ListSpacesRequest.Builder request = ListSpacesRequest.newBuilder()
        // Filter spaces by space type (SPACE or GROUP_CHAT or
        // DIRECT_MESSAGE).
        .setFilter("spaceType = \"SPACE\"")
        // Number of results that will be returned at once.
        .setPageSize(10);

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to list spaces with app credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function listSpacesAppCred() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list(
      {
        filter: filter,
        pageSize: 10,
        pageToken: pageToken,
      },
      getHeaderWithAppCredentials(),
    );
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

Chat API, स्पेस की पेज के हिसाब से बांटी गई सूची दिखाता है.

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

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

  • pageSize: स्पेसों की ज़्यादा से ज़्यादा संख्या. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर यह तय नहीं किया गया है, तो ज़्यादा से ज़्यादा 100 स्पेस दिखाए जाते हैं. इसकी ज़्यादा से ज़्यादा वैल्यू 1,000 हो सकती है. इससे ज़्यादा वैल्यू होने पर,उसे अपने-आप 1,000 में बदल दिया जाता है.
  • pageToken: यह पेज टोकन है. इसे list spaces कॉल से मिला है. अगला पेज पाने के लिए, यह टोकन दें. पेज नंबर बदलते समय, फ़िल्टर की वैल्यू उस कॉल से मेल खानी चाहिए जिसने पेज टोकन दिया था. अलग वैल्यू पास करने से, अनचाहे नतीजे मिल सकते हैं.
  • filter: क्वेरी फ़िल्टर. क्वेरी की जानकारी के लिए, ListSpacesRequest रेफ़रंस देखें.