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

این راهنما نحوه استفاده از متد list() در منبع membership Google Chat API برای فهرست کردن اعضا در یک فضا به‌عنوان فهرست صفحه‌بندی‌شده و قابل فیلتر از عضویت‌ها در یک فضا توضیح می‌دهد.

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

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

پیش نیازها

پایتون

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

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

  • با احراز هویت کاربر ، محدوده مجوز chat.memberships.readonly یا chat.memberships را مشخص کنید.
  • متد list() را در منبع membership فراخوانی کنید.
  • برای فهرست کردن Google Groups، پارامتر query showGroups روی true تنظیم کنید.

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

پایتون

  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 فهرستی از اعضای Google Group، انسان و برنامه را از فضای مشخص شده برمی گرداند.

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

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

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

پایتون

  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 فهرستی از اعضای فضای انسانی (به استثنای مدیران فضا) را از فضای مشخص شده برمی گرداند.

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

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

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

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

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

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

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

  • pageSize : حداکثر تعداد عضویت برای بازگشت. ممکن است این سرویس کمتر از این مقدار را برگرداند. اگر نامشخص باشد، حداکثر 100 فاصله برگردانده می شود. حداکثر مقدار 1000 است. مقادیر بیش از 1000 به طور خودکار به 1000 تغییر می کنند.
  • pageToken : یک نشانه صفحه، دریافت شده از یک تماس قبلی با فاصله لیست. این نشانه را برای بازیابی صفحه بعدی ارائه دهید. هنگام صفحه‌بندی، مقدار فیلتر باید با تماسی که توکن صفحه را ارائه می‌کند، مطابقت داشته باشد. عبور یک مقدار متفاوت ممکن است منجر به نتایج غیرمنتظره شود.
  • filter : یک فیلتر پرس و جو. نیاز به احراز هویت کاربر دارد. برای جزئیات پرس و جو پشتیبانی شده، به متد spaces.members.list() مراجعه کنید.