إدراج أعضاء في مساحة

يوضّح هذا الدليل كيفية استخدام الأسلوب list() في مورد Membership من Google Chat API لإدراج الأعضاء في مساحة كقائمة مُقسّمة إلى صفحات وقابلة للفلترة للاشتراكات في مساحة.

  • عند إدراج الاشتراكات باستخدام مصادقة التطبيق، يتم إدراج الاشتراكات في المساحات التي يمكن لتطبيق Chat الوصول إليها، ولكن يتم استبعاد اشتراكات تطبيق Chat، بما في ذلك اشتراكه الخاص.
  • عند إدراج العضويات باستخدام مصادقة المستخدم، يتم إدراج العضويات في المساحات التي يمكن للمستخدم المُعتمَد الوصول إليها.
  • عند إدراج العضويات بصفتك مشرفًا في Google Workspace مع مصادقة مستخدم باستخدام امتيازات المشرف، يتم إدراج العضويات في جميع المساحات في مؤسستك على Google Workspace.

يمثّل مورد Membership ما إذا كان مستخدمًا أو تطبيق Google Chat قد تمت دعوته للانضمام إلى مساحة أو كان جزءًا منها أو غير متواجد فيها.

المتطلبات الأساسية

Node.js

Python

Java

برمجة تطبيقات

إدراج الأعضاء في مساحة مع مصادقة المستخدم

لإدراج المستخدمين و"مجموعات Google" وتطبيق 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));
      }
    }
  }
}

برمجة تطبيقات

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() أو من عنوان URL للمساحة.

تعرِض 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));
      }
    }
  }
}

برمجة تطبيقات

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() أو من عنوان URL للمساحة.

تعرض Google Chat API قائمة بأعضاء المساحة (باستثناء مدراء المساحة) من المساحة المحدّدة.

إدراج الأعضاء كمشرفين في Google Workspace

إذا كنت مشرفًا في Google Workspace، يمكنك استدعاء الأسلوب ListMemberships() لعرض العضويات لأي مساحة في مؤسّسة Google Workspace. لا تعرض واجهة برمجة التطبيقات Chat API سوى عضويات المستخدمين، سواء الداخليين أو الخارجيين، أو مجموعات Google من مؤسستك، وبالتالي تحذف العضويات في أي تطبيقات Chat.

لاستدعاء هذه الطريقة بصفتك مشرفًا في Google Workspace، اتّبِع الخطوات التالية:

  • استخدِم طريقة المصادقة للمستخدم، وحدِّد نطاق التفويض الذي يتيح استدعاء الطريقة باستخدام امتيازات المشرف.
  • في طلبك، حدِّد مَعلمات طلب البحث التالية:
    • اضبط useAdminAccess على true.
    • لعرض المستخدِمين فقط، اضبط filter لـ member.type على HUMAN.
    • لعرض المستخدمين والمجموعات، اضبط filter لـ member.type ليس يساوي BOT AND showGroups يساوي true.

لمزيد من المعلومات والأمثلة، يُرجى الاطّلاع على مقالة إدارة مساحات Google Chat بصفتك مشرفًا في Google Workspace.

تخصيص تقسيم الصفحات أو فلترة القائمة

لعرض العضويات، نقْل مَعلمات طلب البحث التالية لأجل تخصيص تقسيم الصفحات للعضويات المُدرَجة أو فلترتها:

  • pageSize: الحد الأقصى لعدد الاشتراكات المطلوب عرضها قد تعرِض الخدمة عددًا أقل من هذه القيمة. في حال عدم تحديد عدد، يتم عرض 100 مساحة كحد أقصى. الحد الأقصى للقيمة هو 1,000، ويتم تلقائيًا تغيير القيم التي تزيد عن 1,000 إلى 1,000.
  • pageToken: رمز مميّز للصفحة، تم تلقّيه من مكالمة سابقة في مساحات القائمة قدِّم هذا الرمز المميّز لاسترداد الصفحة اللاحقة. عند تقسيم الصفحات، يجب أن تتطابق قيمة الفلترة مع الطلب الذي قدّم الرمز المميّز للصفحة. قد يؤدي إدخال قيمة مختلفة إلى نتائج غير متوقّعة.
  • filter: فلتر طلب بحث تتطلّب مصادقة المستخدم. لمعرفة تفاصيل طلبات البحث المتوافقة، يُرجى الاطّلاع على مرجع ListMembershipsRequest.