اعضا را در یک فاصله فهرست کنید

این راهنما نحوه استفاده از متد list() در منبع Membership از API چت گوگل را برای فهرست کردن اعضای یک فضا به صورت یک لیست صفحه‌بندی شده و قابل فیلتر از عضویت‌های موجود در یک فضا توضیح می‌دهد.

  • فهرست کردن عضویت‌ها با احراز هویت برنامه، عضویت‌ها را در فضاهایی که برنامه چت به آنها دسترسی دارد فهرست می‌کند، اما عضویت‌های برنامه چت، از جمله عضویت‌های خودش را شامل نمی‌شود.
  • فهرست کردن عضویت‌ها با احراز هویت کاربر، عضویت‌ها در فضاهایی را که کاربر احراز هویت شده به آنها دسترسی دارد، فهرست می‌کند.
  • فهرست کردن عضویت‌ها به عنوان مدیر Google Workspace با احراز هویت کاربر با استفاده از امتیازات مدیر، عضویت‌ها را در تمام فضاهای موجود در سازمان Google Workspace شما فهرست می‌کند.

منبع Membership نشان می‌دهد که آیا یک کاربر انسانی یا برنامه Google Chat به یک فضا دعوت شده، بخشی از آن است یا در آن حضور ندارد.

پیش‌نیازها

نود جی اس

پایتون

جاوا

اسکریپت برنامه‌ها

اعضا را در فضایی با احراز هویت کاربر فهرست کنید

برای فهرست کردن کاربران، گروه‌های گوگل و برنامه چت در فضایی که کاربر احراز هویت شده به آن دسترسی دارد، موارد زیر را در درخواست خود ارسال کنید:

  • با احراز هویت کاربر ، دامنه مجوز chat.memberships.readonly یا chat.memberships را مشخص کنید.
  • متد ListMemberships() را فراخوانی کنید.
  • برای فهرست کردن گروه‌های گوگل، پارامتر کوئری showGroups را روی true تنظیم کنید.

مثال زیر اعضای گروه گوگل، انسان و برنامه را که برای کاربر احراز هویت شده قابل مشاهده هستند، فهرست می‌کند.

نود جی اس

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

await main();

پایتون

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

جاوا

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

اسکریپت برنامه‌ها

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

برای اجرای این نمونه، به جای SPACE_NAME ، شناسه (ID) فیلد name فضا را وارد کنید. می‌توانید شناسه را با فراخوانی متد ListSpaces() یا از طریق URL فضا به دست آورید.

API چت گوگل فهرستی از اعضای گروه گوگل، افراد و اعضای برنامه را از فضای مشخص شده برمی‌گرداند.

اعضا را در فضایی با احراز هویت برنامه فهرست کنید

برای فهرست کردن کاربران و برنامه چت در فضایی که برنامه احراز هویت شده به آن دسترسی دارد، موارد زیر را در درخواست خود ارسال کنید:

  • با احراز هویت برنامه ، دامنه مجوز chat.bot را مشخص کنید.
  • متد ListMemberships() را فراخوانی کنید.
  • برای فهرست کردن گروه‌های گوگل، پارامتر کوئری showGroups را روی true تنظیم کنید.

مثال زیر اعضای فضای انسانی (نه مدیران فضا) قابل مشاهده برای برنامه چت را فهرست می‌کند:

نود جی اس

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

await main();

پایتون

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

جاوا

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

اسکریپت برنامه‌ها

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

برای اجرای این نمونه، به جای SPACE_NAME ، شناسه (ID) فیلد name فضا را وارد کنید. می‌توانید شناسه را با فراخوانی متد ListSpaces() یا از طریق URL فضا به دست آورید.

رابط برنامه‌نویسی کاربردی چت گوگل (Google Chat API) فهرستی از اعضای فضای انسانی (به‌جز مدیران فضا) را از فضای مشخص‌شده برمی‌گرداند.

اعضا را به عنوان مدیر Google Workspace فهرست کنید

اگر شما مدیر Google Workspace هستید، می‌توانید متد ListMemberships() را برای فهرست کردن عضویت‌ها برای هر فضایی در سازمان Google Workspace خود فراخوانی کنید. API چت فقط عضویت‌های مربوط به کاربران - چه داخلی و چه خارجی - یا گروه‌های گوگل از سازمان شما را برمی‌گرداند و بنابراین عضویت‌ها را برای هر برنامه چت حذف می‌کند.

برای فراخوانی این روش به عنوان مدیر Google Workspace، موارد زیر را انجام دهید:

  • با استفاده از احراز هویت کاربر، متد را فراخوانی کنید و یک محدوده مجوز مشخص کنید که از فراخوانی متد با استفاده از امتیازات مدیر پشتیبانی کند.
  • در درخواست خود، پارامترهای پرس و جو زیر را مشخص کنید:
    • useAdminAccess روی true تنظیم کنید.
    • برای اینکه فقط کاربران را برگردانید، filter مربوط به member.type را برابر با HUMAN قرار دهید.
    • برای بازگرداندن کاربران و گروه‌ها، filter را برای member.type برابر با BOT AND showGroups برابر با true تنظیم کنید.

برای اطلاعات و مثال‌های بیشتر، به مدیریت فضاهای چت گوگل به عنوان مدیر فضای کاری گوگل مراجعه کنید.

صفحه‌بندی را سفارشی کنید یا لیست را فیلتر کنید

برای فهرست کردن عضویت‌ها، پارامترهای کوئری زیر را برای سفارشی‌سازی صفحه‌بندی یا فیلتر کردن عضویت‌های فهرست‌شده ارسال کنید:

  • pageSize : حداکثر تعداد عضویت‌هایی که باید برگردانده شود. سرویس ممکن است کمتر از این مقدار را برگرداند. اگر مشخص نشود، حداکثر ۱۰۰ فاصله برگردانده می‌شود. حداکثر مقدار ۱۰۰۰ است؛ مقادیر بیش از ۱۰۰۰ به طور خودکار به ۱۰۰۰ تغییر می‌کنند.
  • pageToken : یک توکن صفحه که از فراخوانی قبلی فضاهای لیست دریافت شده است. این توکن را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحه‌بندی، مقدار فیلتر باید با فراخوانی که توکن صفحه را ارائه داده است، مطابقت داشته باشد. ارسال مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره‌ای شود.
  • filter : یک فیلتر پرس‌وجو. نیاز به احراز هویت کاربر دارد. برای جزئیات پرس‌وجوی پشتیبانی‌شده، به مرجع ListMembershipsRequest مراجعه کنید.