הצגת אירועים ממרחב משותף ב-Google Chat

במדריך הזה מוסבר איך להשתמש ב-method‏ list ב-משאב SpaceEvent של Google Chat API כדי להציג רשימה של שינויים במשאבים במרחב משותף.

משאב SpaceEvent מייצג שינוי במרחב היעד, כולל במשאבי הצאצאים של המרחב כמו הודעות, תגובות וחברויות במועדון. מידע נוסף על המדיניות בנושא רשימה של סוגי אירועים ומטענים ייעודיים (payloads) של אירועים שנתמכים. אפשר לעיין בeventType payload שדות של המשאב SpaceEvent מסמכי עזר.

אפשר לרשום אירועים עד 28 ימים לפני מועד שליחת הבקשה. השרת מחזירה אירועים שמכילים את הגרסה העדכנית ביותר של המשאב המושפע. לדוגמה, אם תרשמו אירועים שכוללים משתתפים חדשים במרחב המשותף, השרת יחזיר Membership משאבים שמכילים את הפרטים העדכניים של המינוי. אם חברים חדשים הוסרו במהלך התקופה המבוקשת, תוכן האירוע יכלול משאב Membership ריק.

כדי לקרוא ל-method הזה, צריך להשתמש באימות משתמשים. כדי להציג רשימה של אירועים במרחב משותף, המשתמש המאומת צריך להיות חבר במרחב המשותף.

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

Python

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

כדי לראות את רשימת האירועים במרחב המשותף מתוך מרחב משותף ב-Chat:

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

Python

  1. בספריית העבודה, יוצרים קובץ בשם chat_space_event_list.py.
  2. מוסיפים את הקוד הבא ב-chat_space_event_list.py:

    """Lists SpaceEvent resources from the Chat API."""
    
    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",
    "https://www.googleapis.com/auth/chat.messages.readonly"]
    
    # 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().spaceEvents().list(
    
        # The space from which to list events.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE',
    
        # A required filter. Filters and returns events about new memberships and messages
        filter='event_types:"google.workspace.chat.membership.v1.created" OR event_types:"google.workspace.chat.message.v1.created"'
    
    ).execute()
    
    # Prints details about the created space events.
    print(result)
    
  3. בקוד, מחליפים את מה שכתוב בשדות הבאים:

    • SPACE: שם של מרחב, שאפשר לקבל ממנו ה-method spaces.list מ-Chat API או מכתובת ה-URL של מרחב משותף.
  4. בספריית העבודה, יוצרים ומריצים את הדוגמה:

    python3 chat_space_event_list.py

ה-Chat API מחזיר רשימה של SpaceEvent מקורות מידע אירועים על הודעות ומינויים חדשים.

התאמה אישית של החלוקה לדפים

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

  • pageSize: מספר המשאבים המקסימלי מסוג SpaceEvent שצריך להחזיר. השירות עשוי להחזיר פחות מהערך הזה. ערכי שליליים מחזירים את השגיאה INVALID_ARGUMENT.
  • pageToken: אסימון דף, שהתקבל מבקשת אירועים קודמת של מרחב רשימות. צריך לספק את האסימון הזה כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. עובר ערך שונה עלול להוביל לתוצאות בלתי צפויות.