این صفحه نحوه ایجاد یک برنامه چت با استفاده از Pub/Sub را توضیح میدهد. این نوع معماری برای برنامه Chat در صورتی مفید است که سازمان شما دارای دیوار آتش باشد، که می تواند از ارسال پیام Chat به برنامه Chat شما جلوگیری کند، یا اگر برنامه Chat از Google Workspace Events API استفاده می کند. با این حال، این معماری دارای محدودیتهای زیر است، زیرا این برنامههای چت فقط میتوانند پیامهای ناهمزمان ارسال و دریافت کنند:
- نمی توان از دیالوگ ها در پیام ها استفاده کرد. در عوض، از پیام کارت استفاده کنید.
- نمیتوان کارتهای جداگانه را با پاسخ همگام بهروزرسانی کرد. در عوض، کل پیام را با فراخوانی متد
patch
بهروزرسانی کنید.
نمودار زیر معماری یک برنامه چت ساخته شده با Pub/Sub را نشان می دهد:
در نمودار قبل، کاربر در حال تعامل با برنامه Pub/Sub Chat دارای جریان اطلاعات زیر است:
یک کاربر پیامی را در Chat به یک برنامه Chat ارسال میکند، یا در یک پیام مستقیم یا در فضای Chat، یا رویدادی در فضای Chat رخ میدهد که برنامه Chat اشتراک فعالی برای آن دارد.
چت پیام را به یک موضوع Pub/Sub ارسال می کند.
یک سرور برنامه، که یا یک سیستم ابری یا درون محل است که حاوی منطق برنامه چت است، در موضوع Pub/Sub مشترک می شود تا پیام را از طریق فایروال دریافت کند.
به صورت اختیاری، برنامه چت میتواند با Chat API تماس بگیرد تا پیامها را به صورت ناهمزمان ارسال کند یا عملیات دیگری را انجام دهد.
پیش نیازها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- جاوا 11 یا بالاتر
- ابزار مدیریت بسته Maven
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- پایتون 3.6 یا بالاتر
- ابزار مدیریت بسته پیپ
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- Node.js 14 یا بالاتر
- ابزار مدیریت بسته npm
- یک پروژه Node.js اولیه. برای مقداردهی اولیه یک پروژه جدید، یک پوشه جدید ایجاد کرده و به آن سوئیچ کنید، سپس دستور زیر را در رابط خط فرمان خود اجرا کنید:
npm init
محیط را تنظیم کنید
قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. میتوانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، Google Chat API و Pub/Sub API را فعال کنید.
Pub/Sub را راه اندازی کنید
یک موضوع Pub/Sub ایجاد کنید که Chat API بتواند به آن پیام ارسال کند. توصیه می کنیم در هر برنامه چت از یک موضوع استفاده کنید.
با اختصاص نقش Pub/Sub Publisher به حساب سرویس زیر ، به Chat اجازه انتشار در موضوع بدهید :
chat-api-push@system.gserviceaccount.com
یک حساب سرویس برای برنامه Chat ایجاد کنید تا با Pub/Sub و Chat مجوز دهید و فایل کلید خصوصی را در فهرست کاری خود ذخیره کنید.
نقش مشترک Pub/Sub Subscriber را در اشتراک برای حساب سرویسی که قبلا ایجاد کرده اید اختصاص دهید .
فیلمنامه را بنویسید
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، یک فایل به نام
pom.xml
ایجاد کنید.در فایل
pom.xml
کد زیر را قرار دهید:در پوشه کاری خود، ساختار دایرکتوری
src/main/java
را ایجاد کنید.در پوشه
src/main/java
، فایلی به نامMain.java
ایجاد کنید.در
Main.java
کد زیر را قرار دهید:
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، فایلی با نام
requirements.txt
ایجاد کنید.در فایل
requirements.txt
کد زیر را قرار دهید:در پوشه کاری خود، یک فایل با نام
app.py
ایجاد کنید.در
app.py
کد زیر را جایگذاری کنید:
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، یک فایل با نام
package.json
ایجاد کنید.در فایل
package.json
کد زیر را قرار دهید:در پوشه کاری خود، یک فایل با نام
index.js
ایجاد کنید.در
index.js
کد زیر را قرار دهید:
برنامه را در چت منتشر کنید
در کنسول Google Cloud، به > APIs & Services > Enabled APIs & Services > Google Chat API > Configuration بروید.
منوبرنامه چت را برای Pub/Sub پیکربندی کنید:
- در نام برنامه ،
Quickstart App
وارد کنید. - در URL آواتار ،
https://developers.google.com/chat/images/quickstart-app-avatar.png
را وارد کنید. - در توضیحات ،
Quickstart app
وارد کنید. - در بخش عملکرد ، دریافت پیام های 1:1 و پیوستن به فضاها و مکالمات گروهی را انتخاب کنید.
- در تنظیمات اتصال ، Cloud Pub/Sub را انتخاب کنید و نام موضوع Pub/Sub را که قبلا ایجاد کردهاید، جایگذاری کنید.
- در قسمت Visibility ، این برنامه Google Chat را برای افراد و گروههای خاصی در دامنه خود در دسترس قرار دهید را انتخاب کنید و آدرس ایمیل خود را وارد کنید.
- در زیر گزارشها ، Log errors to Logging را انتخاب کنید.
- در نام برنامه ،
روی ذخیره کلیک کنید.
این برنامه برای دریافت و پاسخ به پیام ها در چت آماده است.
اسکریپت را اجرا کنید
در یک CLI، به دایرکتوری کاری خود بروید و اسکریپت را اجرا کنید:
mvn compile exec:java -Dexec.mainClass=Main
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
npm install
npm start
هنگامی که کد را اجرا می کنید، برنامه شروع به گوش دادن به پیام های منتشر شده در موضوع Pub/Sub می کند.
برنامه چت خود را تست کنید
برای آزمایش برنامه چت خود، یک فضای پیام مستقیم با برنامه چت باز کنید و یک پیام ارسال کنید:
Google Chat را با استفاده از حساب Google Workspace که هنگام اضافه کردن خود به عنوان آزمایشکننده معتمد ارائه کردهاید، باز کنید.
- روی گپ جدید کلیک کنید.
- در قسمت افزودن 1 یا چند نفر ، نام برنامه چت خود را تایپ کنید.
برنامه چت خود را از نتایج انتخاب کنید. یک پیام مستقیم باز می شود.
- در پیام مستقیم جدید با برنامه،
Hello
تایپ کرده وenter
فشار دهید.
برای افزودن آزمایشکنندگان مورد اعتماد و کسب اطلاعات بیشتر درباره آزمایش ویژگیهای تعاملی، به تست ویژگیهای تعاملی برای برنامههای گپ Google مراجعه کنید.
عیب یابی
وقتی یک برنامه یا کارت Google Chat خطایی را برمیگرداند، رابط Chat پیامی را نشان میدهد که میگوید «مشکلی پیش آمده است». یا "نمی توان به درخواست شما رسیدگی کرد." گاهی اوقات Chat UI هیچ پیام خطایی را نمایش نمی دهد، اما برنامه یا کارت Chat نتیجه غیرمنتظره ای ایجاد می کند. برای مثال، ممکن است پیام کارت ظاهر نشود.
اگرچه ممکن است پیام خطا در رابط کاربری گپ نمایش داده نشود، پیامهای خطای توصیفی و دادههای گزارش در دسترس هستند تا به شما کمک کنند هنگام فعال بودن ثبت خطا برای برنامههای گپ، خطاها را برطرف کنید. برای راهنمایی برای مشاهده، اشکالزدایی و رفع خطاها، به عیبیابی و رفع خطاهای Google Chat مراجعه کنید.
پاک کن
برای جلوگیری از تحمیل هزینه به حساب Google Cloud خود برای منابع استفاده شده در این آموزش، توصیه می کنیم پروژه Cloud را حذف کنید.
- در کنسول Google Cloud، به صفحه مدیریت منابع بروید. IAM & Admin > Manage Resources کلیک کنید. >
- در لیست پروژه، پروژه ای را که می خواهید حذف کنید انتخاب کنید و سپس روی حذف کلیک کنید.
- در گفتگو، ID پروژه را تایپ کنید و سپس بر روی Shut down کلیک کنید تا پروژه حذف شود.
موضوعات مرتبط
برای افزودن ویژگیهای بیشتر به برنامه چت، موارد زیر را ببینید:
این صفحه نحوه ایجاد یک برنامه چت با استفاده از Pub/Sub را توضیح میدهد. این نوع معماری برای برنامه Chat در صورتی مفید است که سازمان شما دارای دیوار آتش باشد، که می تواند از ارسال پیام Chat به برنامه Chat شما جلوگیری کند، یا اگر برنامه Chat از Google Workspace Events API استفاده می کند. با این حال، این معماری دارای محدودیتهای زیر است، زیرا این برنامههای چت فقط میتوانند پیامهای ناهمزمان ارسال و دریافت کنند:
- نمی توان از دیالوگ ها در پیام ها استفاده کرد. در عوض، از پیام کارت استفاده کنید.
- نمیتوان کارتهای جداگانه را با پاسخ همگام بهروزرسانی کرد. در عوض، کل پیام را با فراخوانی متد
patch
بهروزرسانی کنید.
نمودار زیر معماری یک برنامه چت ساخته شده با Pub/Sub را نشان می دهد:
در نمودار قبل، کاربر در حال تعامل با برنامه Pub/Sub Chat دارای جریان اطلاعات زیر است:
یک کاربر پیامی را در Chat به یک برنامه Chat ارسال میکند، یا در یک پیام مستقیم یا در فضای Chat، یا رویدادی در فضای Chat رخ میدهد که برنامه Chat اشتراک فعالی برای آن دارد.
چت پیام را به یک موضوع Pub/Sub ارسال می کند.
یک سرور برنامه، که یا یک سیستم ابری یا درون محل است که حاوی منطق برنامه چت است، در موضوع Pub/Sub مشترک می شود تا پیام را از طریق فایروال دریافت کند.
به صورت اختیاری، برنامه چت میتواند با Chat API تماس بگیرد تا پیامها را به صورت ناهمزمان ارسال کند یا عملیات دیگری را انجام دهد.
پیش نیازها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- جاوا 11 یا بالاتر
- ابزار مدیریت بسته Maven
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- پایتون 3.6 یا بالاتر
- ابزار مدیریت بسته پیپ
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- یک پروژه Google Cloud با فعال کردن صورتحساب. برای بررسی فعال بودن صورتحساب پروژه موجود، به تأیید وضعیت صورتحساب پروژههای خود مراجعه کنید. برای ایجاد پروژه و تنظیم صورتحساب، به ایجاد پروژه Google Cloud مراجعه کنید.
- Node.js 14 یا بالاتر
- ابزار مدیریت بسته npm
- یک پروژه Node.js اولیه. برای مقداردهی اولیه یک پروژه جدید، یک پوشه جدید ایجاد کرده و به آن سوئیچ کنید، سپس دستور زیر را در رابط خط فرمان خود اجرا کنید:
npm init
محیط را تنظیم کنید
قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. میتوانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، Google Chat API و Pub/Sub API را فعال کنید.
Pub/Sub را راه اندازی کنید
یک موضوع Pub/Sub ایجاد کنید که Chat API بتواند به آن پیام ارسال کند. توصیه می کنیم در هر برنامه چت از یک موضوع استفاده کنید.
با اختصاص نقش Pub/Sub Publisher به حساب سرویس زیر ، به Chat اجازه انتشار در موضوع بدهید :
chat-api-push@system.gserviceaccount.com
یک حساب سرویس برای برنامه Chat ایجاد کنید تا با Pub/Sub و Chat مجوز دهید و فایل کلید خصوصی را در فهرست کاری خود ذخیره کنید.
نقش مشترک Pub/Sub Subscriber را در اشتراک برای حساب سرویسی که قبلا ایجاد کرده اید اختصاص دهید .
فیلمنامه را بنویسید
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، یک فایل به نام
pom.xml
ایجاد کنید.در فایل
pom.xml
کد زیر را قرار دهید:در پوشه کاری خود، ساختار دایرکتوری
src/main/java
را ایجاد کنید.در پوشه
src/main/java
، فایلی به نامMain.java
ایجاد کنید.در
Main.java
کد زیر را قرار دهید:
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، فایلی با نام
requirements.txt
ایجاد کنید.در فایل
requirements.txt
کد زیر را قرار دهید:در پوشه کاری خود، یک فایل با نام
app.py
ایجاد کنید.در
app.py
کد زیر را قرار دهید:
در یک CLI، اعتبار حساب خدمات را ارائه دهید :
export GOOGLE_APPLICATION_CREDENTIALS=
SERVICE_ACCOUNT_FILE_PATH در یک CLI، شناسه پروژه Google Cloud را ارائه دهید:
export PROJECT_ID=
PROJECT_ID در یک CLI، شناسه اشتراک را برای اشتراک Pub/Sub که قبلا ایجاد کردهاید، ارائه دهید:
export SUBSCRIPTION_ID=
SUBSCRIPTION_ID در پوشه کاری خود، یک فایل با نام
package.json
ایجاد کنید.در فایل
package.json
کد زیر را قرار دهید:در پوشه کاری خود، یک فایل با نام
index.js
ایجاد کنید.در
index.js
کد زیر را قرار دهید:
برنامه را در چت منتشر کنید
در کنسول Google Cloud، به > APIs & Services > Enabled APIs & Services > Google Chat API > Configuration بروید.
منوبرنامه چت را برای Pub/Sub پیکربندی کنید:
- در نام برنامه ،
Quickstart App
وارد کنید. - در URL آواتار ،
https://developers.google.com/chat/images/quickstart-app-avatar.png
را وارد کنید. - در توضیحات ،
Quickstart app
وارد کنید. - در بخش عملکرد ، دریافت پیام های 1:1 و پیوستن به فضاها و مکالمات گروهی را انتخاب کنید.
- در تنظیمات اتصال ، Cloud Pub/Sub را انتخاب کنید و نام موضوع Pub/Sub را که قبلا ایجاد کردهاید، جایگذاری کنید.
- در قسمت Visibility ، این برنامه Google Chat را برای افراد و گروههای خاصی در دامنه خود در دسترس قرار دهید را انتخاب کنید و آدرس ایمیل خود را وارد کنید.
- در زیر گزارشها ، Log errors to Logging را انتخاب کنید.
- در نام برنامه ،
روی ذخیره کلیک کنید.
این برنامه برای دریافت و پاسخ به پیام ها در چت آماده است.
اسکریپت را اجرا کنید
در یک CLI، به دایرکتوری کاری خود بروید و اسکریپت را اجرا کنید:
mvn compile exec:java -Dexec.mainClass=Main
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
npm install
npm start
هنگامی که کد را اجرا می کنید، برنامه شروع به گوش دادن به پیام های منتشر شده در موضوع Pub/Sub می کند.
برنامه چت خود را تست کنید
برای آزمایش برنامه چت خود، یک فضای پیام مستقیم با برنامه چت باز کنید و یک پیام ارسال کنید:
Google Chat را با استفاده از حساب Google Workspace که هنگام اضافه کردن خود به عنوان آزمایشکننده معتمد ارائه کردهاید، باز کنید.
- روی گپ جدید کلیک کنید.
- در قسمت افزودن 1 یا چند نفر ، نام برنامه چت خود را تایپ کنید.
برنامه چت خود را از نتایج انتخاب کنید. یک پیام مستقیم باز می شود.
- در پیام مستقیم جدید با برنامه،
Hello
تایپ کرده وenter
فشار دهید.
برای افزودن آزمایشکنندگان مورد اعتماد و کسب اطلاعات بیشتر درباره آزمایش ویژگیهای تعاملی، به تست ویژگیهای تعاملی برای برنامههای گپ Google مراجعه کنید.
عیب یابی
وقتی یک برنامه یا کارت Google Chat خطایی را برمیگرداند، رابط Chat پیامی را نشان میدهد که میگوید «مشکلی پیش آمده است». یا "نمی توان به درخواست شما رسیدگی کرد." گاهی اوقات Chat UI هیچ پیام خطایی را نمایش نمی دهد، اما برنامه یا کارت Chat نتیجه غیرمنتظره ای ایجاد می کند. برای مثال، ممکن است پیام کارت ظاهر نشود.
اگرچه ممکن است پیام خطا در رابط کاربری گپ نمایش داده نشود، پیامهای خطای توصیفی و دادههای گزارش در دسترس هستند تا به شما کمک کنند هنگام فعال بودن ثبت خطا برای برنامههای گپ، خطاها را برطرف کنید. برای راهنمایی برای مشاهده، اشکالزدایی و رفع خطاها، به عیبیابی و رفع خطاهای Google Chat مراجعه کنید.
پاک کن
برای جلوگیری از تحمیل هزینه به حساب Google Cloud خود برای منابع استفاده شده در این آموزش، توصیه می کنیم پروژه Cloud را حذف کنید.
- در کنسول Google Cloud، به صفحه مدیریت منابع بروید. IAM & Admin > Manage Resources کلیک کنید. >
- در لیست پروژه، پروژه ای را که می خواهید حذف کنید انتخاب کنید و سپس روی حذف کلیک کنید.
- در گفتگو، ID پروژه را تایپ کنید و سپس بر روی Shut down کلیک کنید تا پروژه حذف شود.
موضوعات مرتبط
برای افزودن ویژگیهای بیشتر به برنامه چت، موارد زیر را ببینید: