Quickstarts نحوه راهاندازی و اجرای برنامهای را توضیح میدهد که Google Workspace API را فراخوانی میکند.
راهاندازیهای سریع Google Workspace از کتابخانههای سرویس گیرنده API برای رسیدگی به برخی از جزئیات جریان احراز هویت و مجوز استفاده میکنند. توصیه می کنیم از کتابخانه های سرویس گیرنده برای برنامه های خود استفاده کنید. این شروع سریع از یک رویکرد احراز هویت ساده استفاده می کند که برای یک محیط آزمایشی مناسب است. برای یک محیط تولید، توصیه میکنیم قبل از انتخاب اعتبارنامههای دسترسی مناسب برای برنامهتان، درباره احراز هویت و مجوز یاد بگیرید.
یک برنامه خط فرمان Node.js ایجاد کنید که به Google Chat API درخواست می دهد.
اهداف
- محیط خود را تنظیم کنید.
- کتابخانه مشتری را نصب کنید.
- نمونه را تنظیم کنید
- نمونه را اجرا کنید.
پیش نیازها
برای اجرای این شروع سریع، به پیش نیازهای زیر نیاز دارید:
- Node.js & npm نصب شد.
- یک پروژه Google Cloud .
- یک حساب Google Workspace تجاری یا سازمانی با دسترسی به Google Chat .
محیط خود را تنظیم کنید
برای تکمیل این شروع سریع، محیط خود را تنظیم کنید.
API را فعال کنید
قبل از استفاده از Google API، باید آنها را در پروژه Google Cloud روشن کنید. میتوانید یک یا چند API را در یک پروژه Google Cloud روشن کنید.در کنسول Google Cloud، Google Chat API را فعال کنید.
صفحه رضایت OAuth را پیکربندی کنید
اگر از یک پروژه جدید Google Cloud برای تکمیل این شروع سریع استفاده میکنید، صفحه رضایت OAuth را پیکربندی کنید و خود را به عنوان کاربر آزمایشی اضافه کنید. اگر قبلاً این مرحله را برای پروژه Cloud خود انجام داده اید، به بخش بعدی بروید.
- در کنسول Google Cloud، به > APIs & Services > صفحه رضایت OAuth بروید. منو
- برای نوع User Internal را انتخاب کنید، سپس روی Create کلیک کنید.
- فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.
در حال حاضر، میتوانید از افزودن دامنهها صرفنظر کنید و روی ذخیره و ادامه کلیک کنید. در آینده، وقتی برنامهای را برای استفاده خارج از سازمان Google Workspace خود ایجاد میکنید، باید نوع کاربر را به خارجی تغییر دهید و سپس محدودههای مجوز مورد نیاز برنامه خود را اضافه کنید.
- خلاصه ثبت برنامه خود را مرور کنید. برای ایجاد تغییرات، روی ویرایش کلیک کنید. اگر ثبت برنامه خوب به نظر می رسد، روی بازگشت به داشبورد کلیک کنید.
مجوز اعتبار برای یک برنامه دسکتاپ
برای احراز هویت کاربران نهایی و دسترسی به داده های کاربر در برنامه خود، باید یک یا چند شناسه مشتری OAuth 2.0 ایجاد کنید. شناسه مشتری برای شناسایی یک برنامه واحد در سرورهای OAuth Google استفاده می شود. اگر برنامه شما روی چندین پلتفرم اجرا می شود، باید برای هر پلتفرم یک شناسه مشتری جداگانه ایجاد کنید.- در کنسول Google Cloud، به > APIs & Services > Credentials بروید. منو
- روی ایجاد اعتبارنامه > شناسه مشتری OAuth کلیک کنید.
- روی نوع برنامه > برنامه دسکتاپ کلیک کنید.
- در قسمت نام ، نامی را برای اعتبارنامه تایپ کنید. این نام فقط در کنسول Google Cloud نشان داده می شود.
- روی ایجاد کلیک کنید. صفحه ایجاد شده توسط سرویس گیرنده OAuth ظاهر می شود که شناسه مشتری و راز مشتری جدید شما را نشان می دهد.
- روی OK کلیک کنید. اعتبار جدید ایجاد شده در شناسه های مشتری OAuth 2.0 ظاهر می شود.
- فایل JSON دانلود شده را به عنوان
credentials.json
ذخیره کنید و فایل را به دایرکتوری کاری خود منتقل کنید.
برنامه Google Chat را پیکربندی کنید
برای تماس با Google Chat API، باید یک برنامه Google Chat را پیکربندی کنید. برای هر درخواست نوشتن، Google Chat برنامه Google Chat را در رابط کاربری با استفاده از اطلاعات زیر نسبت می دهد.
در کنسول Google Cloud، به صفحه پیکربندی Chat API بروید:
در قسمت Application info اطلاعات زیر را وارد کنید:
- در قسمت نام برنامه ،
Chat API quickstart app
را وارد کنید. - در قسمت URL آواتار ،
https://developers.google.com/chat/images/quickstart-app-avatar.png
را وارد کنید. - در قسمت توضیحات ،
Quickstart for calling the Chat API
وارد کنید.
- در قسمت نام برنامه ،
در بخش ویژگیهای تعاملی ، روی گزینه فعال کردن ویژگیهای تعاملی در موقعیت خاموش کلیک کنید تا ویژگیهای تعاملی برای برنامه گپ غیرفعال شود.
روی ذخیره کلیک کنید.
کتابخانه مشتری را نصب کنید
کتابخانه ها را با استفاده از npm نصب کنید:
npm install @google-apps/chat @google-cloud/local-auth@2.1.0 --save
نمونه را تنظیم کنید
در پوشه کاری خود، یک فایل با نام
index.js
ایجاد کنید.در فایل، کد زیر را قرار دهید:
نمونه را اجرا کنید
در پوشه کاری خود، نمونه را اجرا کنید:
node .
- اولین باری که نمونه را اجرا میکنید، از شما میخواهد دسترسی را مجاز کنید:
- اگر قبلاً وارد حساب Google خود نشده اید، هنگامی که از شما خواسته شد وارد شوید. اگر به چندین حساب وارد شده اید، یک حساب را برای استفاده از مجوز انتخاب کنید.
- روی Accept کلیک کنید.
برنامه Nodejs شما اجرا می شود و با Google Chat API تماس می گیرد.
اطلاعات مجوز در سیستم فایل ذخیره می شود، بنابراین دفعه بعد که کد نمونه را اجرا می کنید، از شما درخواست مجوز نمی شود.