איך מציגים את רשימת המשתתפים במרחבים משותפים

במדריך הזה מוסבר איך להשתמש ב-method list במשאב membership של Google Chat API כדי להציג רשימה של חברים במרחב המשותף לפי חלוקה לדפים, שניתן לסנן את רשימת המשתתפים במרחב המשותף. הצגת רשימה של חברויות במועדון של הערוץ אימות אפליקציות רשימה של חברויות במרחבים משותפים באפליקציית Chat גישה למינויים לאפליקציות Chat, אבל לא כוללים אותם, כולל משלו. הצגת רשימה של חברויות במועדון של הערוץ אימות משתמשים מציגה חברויות במרחבים משותפים שלמשתמש המאומת יש גישה אליהם.

משאב אחד (Membership) מייצג אם בוצעה הזמנה של משתמש אנושי או של אפליקציית Google Chat, חלק ממרחב מסוים או חסר בו.

דרישות מוקדמות

Python

הצגת רשימה של המשתתפים במרחבים משותפים עם אימות משתמשים

כדי להציג רשימות משתמשים, קבוצות Google ואפליקציית Chat במרחבים משותפים שלמשתמש המאומת יש גישה אליה, מעבירים את הפרטים הבאים בבקשה:

  • ב- אימות משתמש, צריך לציין את ההרשאה chat.memberships.readonly או chat.memberships היקף.
  • קוראים לפונקציה שיטת list ב משאב membership.
  • כדי להציג רשימה של קבוצות Google, צריך להגדיר את פרמטר השאילתה showGroups כ-true.

בדוגמה הבאה מוצגת רשימה של החברים בקבוצת 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 מחזיר רשימה של חברים בקבוצה ב-Google, של אנשים ושל חברים באפליקציה השטח שצוין.

הצגת רשימה של המשתתפים במרחבים משותפים שאפשר לאמת באמצעות אפליקציות

איך מציגים את רשימת המשתמשים ואפליקציית 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; ערכים מעל 1,000 עוברים אוטומטית ל-1,000.
  • pageToken: אסימון דף, שהתקבל מקריאה קודמת במרחב משותף. צריך לספק את האסימון הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה אסימון הדף. עובר ערך שונה עלול להוביל לתוצאות בלתי צפויות.
  • filter: מסנן שאילתות. נדרשת אימות משתמש. אפשר למצוא פרטים על השאילתות הנתמכות השיטה spaces.members.list.