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

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

يمكن لمالكي المساحات ومديريها حصر إمكانية رؤية قائمة الأعضاء في المساحة. في حال تم حظر إمكانية الاطّلاع على الأعضاء، قد تؤدي الطلبات التي يتم إجراؤها على هذا الإجراء باستخدام مصادقة التطبيق إلى عرض قائمة فارغة أو حذف الاشتراكات التي لا يمكن لأعضاء المساحة الاطّلاع عليها. قد تؤدي الطلبات التي يتم إجراؤها على هذه الطريقة باستخدام مصادقة المستخدم إلى عرض الخطأ PERMISSION_DENIED.

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

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

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

Node.js

Python

جافا

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

عرض قائمة بالأعضاء في مساحة تتطلّب مصادقة المستخدم

لعرض قائمة بالمستخدمين ومجموعات 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);
  }
}

await main();

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

جافا

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 برقم التعريف من الحقل name الخاص بالمساحة. يمكنك الحصول على المعرّف من خلال استدعاء الطريقة ListSpaces أو من عنوان URL الخاص بالمساحة.

تعرض Google Chat API قائمة بأعضاء المجموعات والأشخاص والتطبيقات من المساحة المحدّدة.

عرض قائمة بالأعضاء في مساحة تتطلّب مصادقة التطبيق

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

await main();

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

جافا

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 برقم التعريف من الحقل 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.