این راهنما نحوه استفاده از متد get()
را در منبع Message
Google Chat API برای بازگرداندن جزئیات مربوط به پیام متنی یا کارتی توضیح میدهد.
در Chat API، یک پیام Chat توسط منبع Message
نمایش داده می شود. در حالی که کاربران چت فقط میتوانند پیامهایی ارسال کنند که حاوی متن هستند، برنامههای چت میتوانند از بسیاری از ویژگیهای پیامرسانی دیگر، از جمله نمایش رابطهای کاربری استاتیک یا تعاملی، جمعآوری اطلاعات از کاربران، و ارسال پیامها به صورت خصوصی استفاده کنند. برای اطلاعات بیشتر درباره ویژگیهای پیامرسانی موجود برای Chat API، به نمای کلی پیامهای گپ Google مراجعه کنید.
پیش نیازها
Node.js
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- Node.js Cloud Client Library را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
credentials.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
پایتون
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Client Python Cloud را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
credentials.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
جاوا
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- کتابخانه Java Cloud Client را نصب کنید.
- اعتبارنامه دسترسی را بر اساس نحوه احراز هویت در درخواست Google Chat API خود ایجاد کنید:
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
credentials.json
در فهرست محلی خود ذخیره کنید. - برای احراز هویت بهعنوان برنامه چت، اعتبار حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.json
ذخیره کنید.
- برای احراز هویت به عنوان کاربر چت، اعتبار شناسه مشتری OAuth را ایجاد کنید و اعتبارنامه ها را به عنوان یک فایل JSON با نام
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
اسکریپت برنامه ها
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
- محیط خود را تنظیم کنید:
- یک پروژه Google Cloud ایجاد کنید .
- صفحه رضایت OAuth را پیکربندی کنید .
- Google Chat API را با نام، نماد و توضیحات برای برنامه Chat خود فعال و پیکربندی کنید .
- یک پروژه Apps Script مستقل ایجاد کنید و سرویس گفتگوی پیشرفته را روشن کنید.
- در این راهنما، باید از احراز هویت کاربر یا برنامه استفاده کنید. برای احراز هویت به عنوان برنامه چت، اعتبارنامه حساب سرویس ایجاد کنید. برای مراحل، به تأیید اعتبار و مجوز به عنوان یک برنامه گپ Google مراجعه کنید.
- بر اساس اینکه میخواهید بهعنوان کاربر یا برنامه چت احراز هویت کنید ، محدوده مجوز را انتخاب کنید .
- یک فضای گپ Google که کاربر احراز هویت شده یا برنامه چت تماس گیرنده عضو آن است. برای احراز هویت به عنوان برنامه Chat، برنامه Chat را به فضا اضافه کنید .
دریافت پیام با احراز هویت کاربر
برای دریافت جزئیات یک پیام با احراز هویت کاربر ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز
chat.messages.readonly
یاchat.messages
را مشخص کنید. - متد
GetMessage()
را فراخوانی کنید. -
name
به نام منبع پیام برای دریافت تنظیم کنید.
مثال زیر پیامی با احراز هویت کاربر دریافت می کند:
Node.js
پایتون
جاوا
اسکریپت برنامه ها
برای اجرای این نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME
: شناسه ازname
فضا. شما می توانید شناسه را با فراخوانی متدListSpaces()
یا از URL فضا بدست آورید. -
MESSAGE_NAME
: شناسه ازname
پیام. می توانید شناسه را از بدنه پاسخی که پس از ایجاد پیام به طور ناهمزمان با Chat API یا با نام سفارشی اختصاص داده شده به پیام در هنگام ایجاد، بازگردانده شده است، دریافت کنید.
Chat API نمونهای از Message
را برمیگرداند که جزئیات پیام مشخصشده را نشان میدهد.
با احراز هویت برنامه پیامی دریافت کنید
برای دریافت جزئیات پیام با احراز هویت برنامه ، موارد زیر را در درخواست خود ارسال کنید:
- محدوده مجوز را مشخص کنید. نمونههای این بخش از محدوده
chat.bot
استفاده میکنند که عموماً در دسترس است و نیازی به تأیید سرپرست ندارد. همچنین، میتوانید با تأیید سرپرست که در پیشنمایش برنامهنویس موجود است، بهعنوان برنامه گپ مجوز دهید. - متد
GetMessage()
را فراخوانی کنید. -
name
به نام منبع پیام برای دریافت تنظیم کنید.
مثال زیر پیامی با احراز هویت برنامه دریافت می کند:
Node.js
پایتون
جاوا
اسکریپت برنامه ها
برای اجرای این نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME
: شناسه ازname
فضا. شما می توانید شناسه را با فراخوانی متدListSpaces()
یا از URL فضا بدست آورید. -
MESSAGE_NAME
: شناسه ازname
پیام. می توانید شناسه را از بدنه پاسخی که پس از ایجاد پیام به طور ناهمزمان با Chat API یا با نام سفارشی اختصاص داده شده به پیام در هنگام ایجاد، بازگردانده شده است، دریافت کنید.
Chat API نمونهای از Message
را برمیگرداند که جزئیات پیام مشخصشده را نشان میدهد.
با تأیید سرپرست، پیامی را به عنوان برنامه چت دریافت کنید
احراز هویت برنامه با دامنه مجوز chat.app.*
به تأیید یک بار سرپرست نیاز دارد.
برای دریافت جزئیات پیام با تأیید اعتبار برنامه با استفاده از Chat REST API ، موارد زیر را در درخواست خود ارسال کنید:
- متد
GetMessage()
را فراخوانی کنید. - محدوده مجوز
chat.app.messages.readonly
مشخص کنید. -
name
به نام منبع پیام برای دریافت تنظیم کنید.
یک کلید API ایجاد کنید
برای فراخوانی یک روش API پیشنمایش برنامهنویس، باید از یک نسخه پیشنمایش برنامهنویس غیرعمومی سند کشف API استفاده کنید. برای احراز هویت درخواست، باید یک کلید API ارسال کنید.
برای ایجاد کلید API، پروژه Google Cloud برنامه خود را باز کنید و کارهای زیر را انجام دهید:
- در کنسول Google Cloud، به > APIs & Services > Credentials بروید.
- روی ایجاد اعتبارنامه > کلید API کلیک کنید.
- کلید API جدید شما نمایش داده می شود.
- روی Copy کلیک کنید تا کلید API خود را برای استفاده در کد برنامه خود کپی کنید. کلید API را میتوانید در بخش «کلیدهای API» اعتبار پروژهتان پیدا کنید.
- برای جلوگیری از استفاده غیرمجاز، توصیه میکنیم کلید API را در کجا و برای کدام APIها محدود کنید. برای جزئیات بیشتر، به افزودن محدودیتهای API مراجعه کنید.
اسکریپتی بنویسید که Chat API را فراخوانی کند
در اینجا نحوه دریافت جزئیات پیام با تأیید اعتبار برنامه و تأیید سرپرست و Chat REST API آمده است:
پایتون
- در فهرست کاری خود، فایلی با نام
chat_messages_get_admin_app.py
ایجاد کنید. کد زیر را در
chat_messages_get_admin_app.py
قرار دهید:from google.oauth2 import service_account from apiclient.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.app.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then gets details about a message. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().messages().get( # The message to get details about. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/messages/MESSAGE_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()
در کد زیر را جایگزین کنید:
-
API_KEY
: کلید API که برای ساختن نقطه پایانی سرویس برای Chat API ایجاد کردید. -
SPACE_NAME
: شناسه ازname
فضا. شما می توانید شناسه را با فراخوانی متدListSpaces()
یا از URL فضا بدست آورید. -
MESSAGE_NAME
: شناسه ازname
پیام. می توانید شناسه را از بدنه پاسخی که پس از ایجاد پیام به طور ناهمزمان با Chat API یا با نام سفارشی اختصاص داده شده به پیام در هنگام ایجاد، بازگردانده شده است، دریافت کنید.
-
در پوشه کاری خود، نمونه را بسازید و اجرا کنید:
python3 chat_messages_get_admin_app.py
Chat API نمونهای از Message
را برمیگرداند که جزئیات پیام مشخصشده را نشان میدهد.
موضوعات مرتبط
- یک پیام را قالب بندی کنید .
- یک پیام را حذف کنید .
- لیست پیام ها در یک فاصله
- یک پیام را به روز کنید .
- پیام بدید .