הרשמה לאירועים של Google Chat

בדף הזה מתוארים האירועים ב-Google Chat שאפליקציית Google Chat יכולה להירשם אליהם באמצעות Google Workspace Event API.

למידע נוסף על פיתוח אפליקציות ל-Google Chat, קראו את הסקירה הכללית על Google Chat API.

מקורות מידע נתמכים לטירגוט ב-Chat

Google Workspace Event API תומך במינויים הבאים:

  • מרחבים משותפים, מיוצגים בתור משאבים של space
  • משתמשים, מיוצגים כמשאבי Cloud Identity API user

אירועים נתמכים ב-Chat

מינויים ל-Google Workspace מאפשרים לקבל ב-Chat אירועים בקשר לשינויים הבאים:

  • הודעות חדשות או מעודכנות במרחב המשותף.
  • תגובות חדשות או שהוסרו להודעה.
  • חברים חדשים, עודכנו או הוסרו במרחב המשותף.
  • שינויים במרחב המשותף שנרשמתם אליו, כמו שם או תיאור מעודכנים של המרחב המשותף.

סוגי אירועים של יצירת מינויים

כשיוצרים מינוי, צריך להשתמש בשדה eventTypes[] כדי לציין את סוגי האירועים שרוצים לקבל. הפורמט של סוגי האירועים תואם למפרט של CloudEvents, למשל google.workspace.APPLICATION.RESOURCE.VERSION.ACTION.

לדוגמה, כדי לקבל אירועים של משתמשים שמצטרפים למרחב משותף ב-Chat, צריך לציין את המרחב המשותף כמשאב היעד ואת סוג האירוע בתור google.workspace.chat.membership.v1.created. כדי לקבל אירועים של הצטרפות של משתמש מסוים למרחב משותף כלשהו, צריך לציין את המשתמש כמשאב היעד ואת סוג האירוע כ-google.workspace.chat.membership.v1.created. מידע נוסף על אופן הפעולה של אירועים זמין במאמר מבנה האירועים ב-Google Workspace.

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

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

google.workspace.chat.message.v1.created

פורסמה הודעה חדשה.

space.message

google.workspace.chat.message.v1.updated

ההודעה מתעדכנת.

space.message

google.workspace.chat.reaction.v1.created

נוצרת תגובה.

space.message.reaction

google.workspace.chat.reaction.v1.deleted

התגובה נמחקה.

space.message.reaction

google.workspace.chat.membership.v1.created

במרחב המשותף הזה נוצר חבר.

space.membership

google.workspace.chat.membership.v1.updated

במרחב המשותף הזה יש עדכונים על אחד מהמשתתפים.

space.membership

google.workspace.chat.membership.v1.deleted

מישהו הוסר מהמרחב המשותף.

space.membership

google.workspace.chat.space.v1.updated

המרחב המשותף מעודכן.

space

google.workspace.chat.space.v1.deleted

המרחב המשותף נמחק.

space

מינויים למשתמשים  

google.workspace.chat.membership.v1.created

המשתמש מצטרף למרחב משותף.

space.membership

google.workspace.chat.membership.v1.updated

המינוי של המשתמש במרחב משותף יעודכן.

space.membership

google.workspace.chat.membership.v1.deleted

המשתמש יוסר ממרחב משותף.

space.membership

סוגי אירועים של פלט בלבד

הרשמה ל-google.workspace.APPLICATION.RESOURCE.VERSION.ACTION סוגי אירועים מגדירה את המינוי באופן אוטומטי כך שתקבלו גם גרסאות מקובצות של סוג האירוע. לדוגמה, אם נרשמים ל-google.workspace.chat.membership.v1.created, מקבלים גם אירועים של google.workspace.chat.membership.v1.batchCreated.

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

סוג האירוע תיאור נתוני משאבים

google.workspace.chat.message.v1.batchCreated

מפורסמות כמה הודעות בו-זמנית.

רשימה של spaces.messages

google.workspace.chat.message.v1.batchUpdated

הודעות מרובות מתעדכנות בו-זמנית.

רשימה של spaces.messages

google.workspace.chat.reaction.v1.batchCreated

נוצרות כמה תגובות בו-זמנית.

רשימה של spaces.messages.reactions

google.workspace.chat.reaction.v1.batchDeleted

כמה תגובות נמחקות בו-זמנית.

רשימה של spaces.messages.reactions

google.workspace.chat.membership.v1.batchCreated

  • אם target_resource הוא מרחב משותף: ייווצרו מספר אנשים במרחב המשותף.
  • אם target_resource הוא משתמש: המשתמש מתחבר לכמה מרחבים משותפים.

רשימה של spaces.memberships

google.workspace.chat.membership.v1.batchUpdated

  • אם target_resource הוא מרחב משותף: כמה משתתפים יעודכנו במרחב המשותף.
  • אם target_resource הוא משתמש: המינויים של המשתמש במרחבים משותפים מקבלים כמה עדכונים.

רשימה של spaces.memberships

google.workspace.chat.membership.v1.batchDeleted

  • אם target_resource הוא מרחב משותף: כמה אנשים יוסרו מהמרחב המשותף.
  • אם target_resource הוא משתמש: המשתמש יוסר כחבר בכמה מרחבים משותפים.

רשימה של spaces.memberships

google.workspace.chat.space.v1.batchUpdated

בוצעו כמה עדכונים במרחב המשותף.

רשימה של spaces

נתוני אירוע

בקטע הזה מתוארים נתוני אירועים ומטענים ייעודיים (payloads) לאירועים ב-Chat.

כשמקבלים אירוע מ-Chat במינוי ל-Google Workspace, השדה data מכיל את המטען הייעודי (payload) של האירוע. המטען הייעודי כולל מידע על המשאב של Google Workspace שהשתנה. לדוגמה, אם נרשמתם לאירועי חברות במרחב משותף, המטען הייעודי של האירועים האלה מכיל מידע על המשאב spaces.membership שהשתנה.

נתוני המשאבים במטען הייעודי (payload) של האירוע

כשיוצרים מינוי, ניתן לציין אם רוצים שהמטען הייעודי (payload) יכלול פרטים על המשאב, או רק את שם המשאב. לדוגמה, אם רוצים לקבל אירועים לגבי חברים במרחב משותף ב-Chat, אפשר לציין אילו שדות של משאב החברוּת רוצים לקבל במטען הייעודי (payload) של האירוע.

בטבלה הבאה מובאות דוגמאות של מטענים ייעודיים (payloads) של JSON למינוי במרחב המשותף ב-Chat spaces/AAAABBBBBB. המטען הייעודי מופיע בשדה data של האירוע לכל אירוע במינוי מקבל:

דוגמה סוג האירוע מטען ייעודי (payload) של JSON

משתמש מפרסם במרחב המשותף הודעה שבה כתוב 'שלום עולם'.

google.workspace.chat.message.v1.created

כולל נתוני משאבים
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD",
        "sender":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "2023-09-07T21:37:36.260127Z",
        "text": "Hello world",
        "thread":
        {
            "name": "spaces/AAAABBBBBB/threads/EEEEEEEEEEEE"
        },
        "space":
        {
            "name": "spaces/AAAABBBBBB"
        },
        "argumentText": "Hello world"
    }
}
      
לא כולל נתוני משאבים
{
    "message":
    {
        "name": "spaces/AAAABBBBBB/messages/CCCCCCCCC.DDDDDDDDD"
    }
}
      
משתמש הופך למנהל/ת של המרחב המשותף.

google.workspace.chat.membership.v1.updated

כולל נתוני משאבים
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321",
        "state": "JOINED",
        "member":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "createTime": "1970-01-01T00:00:00Z",
        "role": "ROLE_MANAGER"
    }
}
      
לא כולל נתוני משאבים
{
    "membership":
    {
        "name": "spaces/AAAABBBBBB/members/1234567890987654321"
    }
}
      
משתמש מעדכן את התיאור של המרחב המשותף ל'צוות המכירות של Cymbal Labs'. google.workspace.chat.space.v1.updated
כולל נתוני משאבים
{
    "space":
    {
        "name": "spaces/AAAABBBBBB",
        "displayName": "Cymbal Sales",
        "spaceThreadingState": "THREADED_MESSAGES",
        "spaceType": "SPACE",
        "spaceDetails":
        {
            "description": "Sales team for Cymbal Labs."
        },
        "spaceHistoryState": "HISTORY_ON"
    }
}
      
לא כולל נתוני משאבים
{
    "space":
    {
        "name": "spaces/AAAABBBBBB"
    }
}
      
שני משתמשי Chat נוספו למרחב המשותף בו-זמנית. google.workspace.chat.membership.v1.batchCreated
כולל נתוני משאבים
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321",
            "state": "JOINED",
            "member":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/987654321234567890",
            "state": "JOINED",
            "member":
            {
                "name": "users/987654321234567890",
                "type": "HUMAN"
            },
            "createTime": "1970-01-01T00:00:00Z",
            "role": "ROLE_MEMBER"
          }
        }
    ]
}
      
לא כולל נתוני משאבים
{
    "memberships": [
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/1234567890987654321"
          }
        },
        {
          "membership": {
            "name": "spaces/AAAABBBBBB/members/98765432123456789019"
          }
        }
    ]
}
      
משתמש מגיב להודעה עם האמוג'י 😊. google.workspace.chat.reaction.v1.created
כולל נתוני משאבים
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
        "user":
        {
            "name": "users/1234567890987654321",
            "type": "HUMAN"
        },
        "emoji":
        {
            "unicode": "😊"
        }
    }
}
      
השמטת נתוני משאבים
{
    "reaction":
    {
        "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
    }
}
      
משתמשים מגיבים להודעה באמוג'י 😊 ובאמוג'י 😸. google.workspace.chat.reaction.v1.batchCreated
כולל נתוני משאבים
{
    "reactions": [
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222",
            "user":
            {
                "name": "users/1234567890987654321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😊"
            }
          }
        },
        {
          "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
            "user":
            {
                "name": "users/98765431234564321",
                "type": "HUMAN"
            },
            "emoji":
            {
                "unicode": "😸"
            }
          }
        }
    ]
}
      
השמטת נתוני משאבים
{
    "reactions": [
      {
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/1111111111111111.222222222222222"
        },
        "reaction": {
            "name": "spaces/AAAABBBBBB/messages/123456789.123456789/reactions/3333333333333333.444444444444444",
        }
      }
    ]
}