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

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

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

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

Python

  • Python 3.6 أو أحدث
  • أداة إدارة حزم pip
  • أحدث مكتبات عملاء Google. لتثبيت التطبيقات أو تحديثها، قم بتشغيل الأمر التالي في واجهة سطر الأوامر: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

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

إدراج المستخدمين و"مجموعات Google" وتطبيق Chat في مساحة الذي يتمتع المستخدم الذي تمت مصادقته بإمكانية الدخول إليه، أدخل ما يلي في طلبك:

يسرد المثال التالي "مجموعة Google" والمستخدمين وأعضاء التطبيق المرئيين المستخدم الذي تمت مصادقته.

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_member_list_user.py".

  2. أدرِج الرمز التالي في chat_member_list_user.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists Google Group, human, and app members in a specified space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # Set this parameter to list Google Groups.
        showGroups = 'true'

    ).execute()

    # Prints the list of memberships.
    print(result)

if __name__ == '__main__':
    main()

  3. في الرمز، استبدِل SPACE باسم مساحة التي يمكنك الحصول عليها من طريقة واحدة (spaces.list) في Chat API أو من عنوان URL للمساحة.

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_member_list_user.py

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

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

لإدراج المستخدمين وتطبيق Chat في مساحة الذي يمكن للتطبيق الذي تمت مصادقته الوصول إليه، أدخِل ما يلي في طلبك:

يسرد المثال التالي أعضاء المساحة البشرية (وليس مدراء المساحة) المرئيين لـ تطبيق Chat:

Python

  1. في دليل العمل، أنشِئ ملفًا باسم "chat_member_list_app.py".

  2. أدرِج الرمز التالي في chat_member_list_app.py:

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

print(result)

  3. في الرمز، استبدِل SPACE باسم مساحة التي يمكنك الحصول عليها من طريقة واحدة (spaces.list) في Chat API أو من عنوان URL للمساحة.

  4. في دليل العمل، أنشئ النموذج وشغِّله:

    python3 chat_member_list_app.py

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

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

لإدراج العضويات، أدخِل مَعلمات طلب البحث التالية إلى يمكنك تخصيص التقسيم على صفحات للعضويات المدرَجة في القائمة أو فلترتها:

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