در رویدادهای چت Google مشترک شوید

این صفحه رویدادهای Google Chat را توضیح می‌دهد که یک برنامه Google Chat می‌تواند با استفاده از Google Workspace Events API در آنها مشترک شود. بعد از اینکه تصمیم گرفتید به چه نوع رویدادهایی نیاز دارید، برای شروع دریافت رویدادها از چت Google ، اشتراکی ایجاد کنید .

علاوه بر اشتراک در رویدادها، می‌توانید با تماس با Chat API، رویدادها را نیز جستجو کنید. تماس با Chat API به شما امکان می‌دهد رویدادها را به صورت دوره‌ای بازیابی کنید، یا به رویدادهایی که ممکن است به دلیل قطعی اشتراک از دست داده باشید، مطلع شوید. برای آشنایی با روش‌هایی که می‌توانید رویدادهای Chat را دریافت کرده و به آنها پاسخ دهید، به کار با رویدادها از Google Chat در اسناد گپ مراجعه کنید.

پشتیبانی از منابع هدف چت

Google Workspace Events API از اشتراک‌ها در موارد زیر پشتیبانی می‌کند:

• فضاها، به عنوان منابع space نشان داده می شوند
• کاربران، به عنوان منابع user Cloud Identity API نشان داده می شوند

رویدادهای چت پشتیبانی شده

اشتراک‌های Google Workspace به شما امکان می‌دهند رویدادهایی را درباره انواع تغییرات زیر در Chat دریافت کنید:

• پیام های جدید، به روز شده یا حذف شده در فضا.
• واکنش های جدید یا حذف شده به یک پیام.
• اعضای جدید، به روز یا حذف شده در فضا.
• تغییراتی در فضایی که در آن مشترک شده‌اید، مانند نام یا شرح فضای به‌روز شده.

انواع رویداد برای ایجاد اشتراک

وقتی اشتراکی ایجاد می‌کنید، از فیلد eventTypes[] برای تعیین انواع رویدادهایی که می‌خواهید دریافت کنید استفاده می‌کنید. انواع رویدادها بر اساس مشخصات CloudEvents، مانند google.workspace. APPLICATION . RESOURCE . VERSION . ACTION .

به عنوان مثال، برای دریافت رویدادهایی درباره پیوستن کاربران به فضای چت، فضا را به عنوان منبع هدف و نوع رویداد را به عنوان google.workspace.chat.membership.v1.created مشخص می‌کنید. برای دریافت رویدادهایی درباره پیوستن کاربر به هر فضایی، کاربر را به عنوان منبع هدف و نوع رویداد را google.workspace.chat.membership.v1.created مشخص می‌کنید. برای اطلاعات بیشتر درباره نحوه عملکرد رویدادها، به ساختار رویدادهای Google Workspace مراجعه کنید.

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

انواع رویداد دسته ای (فقط خروجی)

برنامه گپ شما علاوه بر دریافت انواع رویدادهایی که در آنها مشترک هستید، ممکن است رویدادهای دسته‌ای را نیز دریافت کند. رویداد دسته‌ای رویدادی است که نشان‌دهنده بسیاری از رویدادهای مشابه است که در مدت زمان کوتاهی رخ می‌دهند. محموله یک رویداد دسته ای شامل فهرستی از تمام منابع تغییر یافته است.

برای مثال، اگر کاربری همزمان 20 کاربر را به یک فضا اضافه کند، برنامه Chat شما ممکن است یک رویداد دسته‌ای دریافت کند ( google.workspace.chat.membership.v1.batchCreated ). بارگذاری رویداد حاوی لیستی از تمام منابع Membership جدید است که هنگام افزودن اعضا به فضا توسط کاربر ایجاد شده است.

برای هر نوع رویدادی که در آن مشترک هستید، یک رویداد دسته‌ای دریافت می‌کنید، بنابراین نیازی نیست هنگام ایجاد اشتراک، رویدادهای دسته‌ای را مشخص کنید. برای مثال، اگر در واکنش‌های جدید مشترک شوید ( google.workspace.chat.reaction.v1.created )، برنامه Chat شما به‌طور خودکار برای دریافت رویدادهای واکنش دسته‌ای پیکربندی می‌شود ( google.workspace.chat.reaction.v1.batchCreated ).

جدول زیر رویدادهای دسته ای احتمالی برای یک اشتراک را نشان می دهد:

داده های رویداد

این بخش داده‌های رویداد و بارهای نمونه برای رویدادها در Chat را توضیح می‌دهد.

وقتی اشتراک Google Workspace شما رویدادی را از Chat دریافت می‌کند، فیلد data حاوی محموله رویداد است. این محموله اطلاعاتی درباره منبع Google Workspace دارد که تغییر کرده است. به عنوان مثال، اگر در رویدادهای عضویت در یک فضا مشترک شده باشید، محموله این رویدادها حاوی اطلاعاتی درباره منبع spaces.membership است که تغییر کرده است.

داده های منبع در بارگذاری رویداد

وقتی اشتراکی ایجاد می‌کنید، می‌توانید تعیین کنید که آیا می‌خواهید بارگذاری شامل جزئیات مربوط به منبع باشد یا فقط نام منبع. برای مثال، اگر می‌خواهید رویدادهای مربوط به اعضا را در فضای چت دریافت کنید، می‌توانید مشخص کنید که کدام قسمت‌های منبع عضویت را می‌خواهید در بار رویداد دریافت کنید.

جدول زیر نمونه‌هایی از بارهای JSON را برای اشتراک در spaces/AAAABBBBBB ارائه می‌کند. برای هر رویدادی که اشتراک دریافت می‌کند، محموله در قسمت data رویداد ظاهر می‌شود:

{
    "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"
    }
}
      

{
    "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"
    }
}
      

{
    "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"
    }
}
      

{
    "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"
          }
        }
    ]
}
      

{
    "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"
    }
}
      

{
    "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",
        }
      }
    ]
}
      

• برای اشتراک‌های کاربران، رویدادهای مربوط به اعضای جدید در پیام‌های مستقیم یا چت‌های گروهی بدون نام ( google.workspace.chat.membership.v1.created )، فقط پس از پست شدن اولین پیام فعال می‌شوند.
• تغییرات در تاریخچه فضا، رویدادهای فضایی به‌روزرسانی شده را راه‌اندازی نمی‌کند (نوع رویداد: google.workspace.chat.spaces.v1.updated ).
• برای دریافت رویدادهای عضویت، کاربر باید عضو مستقیم فضا باشد. اگر کاربری به‌طور غیرمستقیم از طریق یک گروه Google به فضایی اضافه، به‌روزرسانی یا حذف شده باشد، اشتراک آن رویدادهای عضویت را دریافت نمی‌کند. برای درک نحوه عملکرد عضویت در گروه Google، به افزودن یک گروه Google به یک فضا مراجعه کنید.

مطالب مرتبط

• ساختار رویدادهای Google Workspace
• دامنه های OAuth را انتخاب کنید
• برای دریافت رویدادهای چت اشتراکی ایجاد کنید