קבלת פרטים על המינוי של משתמש או של אפליקציית Google Chat

במדריך הזה מוסבר איך משתמשים בשיטה get במשאב membership ב-Google Chat API כדי לקבל פרטים על המינוי של משתמש או של אפליקציית Chat במרחבים משותפים.

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

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

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

Python

  • Python 3.6 ואילך
  • הכלי pip לניהול חבילות

  • ספריות הלקוח העדכניות של Google ל-Python. כדי להתקין או לעדכן אותן, מריצים את הפקודה הבאה בממשק שורת הפקודה:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • פרויקט ב-Google Cloud עם ממשק Google Chat API פעיל ומוגדר. במאמר איך יוצרים אפליקציה ל-Google Chat מוסבר איך עושים זאת.

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

הצגת פרטים על מינוי של משתמש או על מינוי של אפליקציה ל-Chat

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

  • באמצעות אימות אפליקציות, מציינים את היקף ההרשאות chat.bot. באמצעות אימות משתמשים, מציינים את היקף ההרשאה chat.memberships.readonly או chat.memberships. השיטה המומלצת היא לבחור את ההיקף המגביל ביותר שעדיין מאפשר לאפליקציה לפעול.
  • קוראים ל-method get במשאב membership.
  • כדי לקבל גישה, צריך לעבור את name של המינוי. תוכלו להשיג את שם החברות ברשימה ממשאב המינויים של Google Chat.

כך נרשמים למועדון החברים באמצעות אימות משתמש:

Python

  1. בספריית העבודה, יוצרים קובץ בשם chat_membership_get.py.

  2. יש לכלול את הקוד הבא ב-chat_membership_get.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 gets details about a specified membership.
    '''

    # 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().get(

        # The membership to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MEMBER with a membership name.
        # Obtain the membership name from the memberships resource of
        # Chat API.
        name='spaces/SPACE/members/MEMBER'

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. בקוד, מחליפים את מה שכתוב בשדות הבאים:

    • SPACE: שם המרחב המשותף. המשתמש יכול לקבל מ-ה-method spaces.list ב-Chat API או מכתובת ה-URL של המרחב המשותף.
    • MEMBER: שם המינוי, שאותו אפשר לקבל דרך ה-method spaces.members.list ב-Chat API.

  4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    python3 chat_membership_get.py

ה-Chat API מחזיר מופע של membership שמפרט את המינוי שצוין.