این سند حاوی اطلاعات مجوز و احراز هویت ویژه API رویدادهای Google Workspace است. قبل از خواندن این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در اطلاعات مربوط به احراز هویت و مجوز مطالعه کنید.
OAuth 2.0 را برای مجوز پیکربندی کنید
صفحه رضایت OAuth را پیکربندی کنید و دامنه ها را انتخاب کنید تا مشخص کنید چه اطلاعاتی برای کاربران و بازبینان برنامه نمایش داده می شود و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.
حوزه های API رویدادهای Google Workspace
برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید محدوده های مجوز را شناسایی و اعلام کنید. محدوده مجوز یک رشته URI OAuth 2.0 است که حاوی نام برنامه Google Workspace، نوع داده‌هایی است که به آن دسترسی دارد و سطح دسترسی. Scopes درخواست‌های برنامه شما برای کار با داده‌های Google Workspace، از جمله داده‌های حساب Google کاربران است.
هنگامی که برنامه شما نصب می شود، از کاربر خواسته می شود تا محدوده های مورد استفاده برنامه را تأیید کند. به طور کلی، شما باید محدودترین محدوده ممکن را انتخاب کنید و از درخواست دامنه هایی که برنامه شما به آن نیاز ندارد اجتناب کنید. کاربران با سهولت بیشتری به محدوده‌های محدود و به وضوح توضیح داده شده دسترسی می‌دهند.
در صورت امکان، استفاده از دامنه‌های غیر حساس را توصیه می‌کنیم زیرا دامنه دسترسی به هر فایل را می‌دهد و دسترسی به عملکرد خاصی را که برای یک برنامه مورد نیاز است محدود می‌کند.
Google Workspace Events API از دامنه‌های برنامه‌های Google Workspace استفاده می‌کند که از اشتراک‌ها پشتیبانی می‌کنند. اگر برنامه شما قبلاً از محدوده‌های مورد نیاز برای اشتراک شما استفاده می‌کند، برای استفاده از Google Workspace Events API نیازی به افزودن دامنه‌های اضافی ندارید.
جدول زیر دامنه های پشتیبانی شده برای Google Workspace Events API را نشان می دهد:
| کد محدوده | توضیحات | استفاده | ||
|---|---|---|---|---|
| چت گوگل | ||||
https://www.googleapis.com/auth/chat.bot | به برنامه‌های Google Chat اجازه می‌دهد چت‌ها را مشاهده کرده و پیام ارسال کنند. به همه ویژگی‌های موجود در برنامه‌های چت دسترسی می‌دهد. | غیر حساس | ||
https://www.googleapis.com/auth/chat.memberships | مشاهده، افزودن و حذف اعضا از مکالمات در Google Chat. | حساس | ||
https://www.googleapis.com/auth/chat.memberships.readonly | مشاهده اعضا در مکالمات Google Chat. | حساس | ||
https://www.googleapis.com/auth/chat.app.memberships | مشاهده، افزودن، به‌روزرسانی و حذف اعضا از مکالمات و فضاهای موجود در Google Chat به‌عنوان برنامه چت. نیاز به تایید مدیر این محدوده فقط از تأیید اعتبار برنامه با حساب های خدمات پشتیبانی می کند. با استفاده از این محدوده نمی‌توانید با اعتبار کاربری یا با تفویض اختیار در سطح دامنه احراز هویت کنید. | حساس | ||
https://www.googleapis.com/auth/chat.spaces | مکالمات و فضاها ایجاد کنید و ابرداده ها (از جمله تنظیمات سابقه) را در چت Google مشاهده یا به روز کنید. | حساس | ||
https://www.googleapis.com/auth/chat.spaces.readonly | چت و فضاها را در چت Google مشاهده کنید. | حساس | ||
https://www.googleapis.com/auth/chat.app.spaces | مکالمات و فضاها ایجاد کنید و ابرداده ها (از جمله تنظیمات سابقه) را در Google Chat به عنوان یک برنامه چت مشاهده یا به روز کنید. نیاز به تایید مدیر این محدوده فقط از تأیید اعتبار برنامه با حساب های خدمات پشتیبانی می کند. با استفاده از این محدوده نمی‌توانید با اعتبار کاربری یا با تفویض اختیار در سطح دامنه احراز هویت کنید. | حساس | ||
https://www.googleapis.com/auth/chat.messages.reaction s | مشاهده، افزودن و حذف واکنش‌ها به پیام‌ها در چت. | حساس | ||
https://www.googleapis.com/auth/chat.messages.reactions.readonly | مشاهده واکنش‌ها به یک پیام در چت. | حساس | ||
https://www.googleapis.com/auth/chat.messages | مشاهده، نوشتن، ارسال، به‌روزرسانی و حذف پیام‌ها و افزودن، مشاهده و حذف واکنش‌ها به پیام‌ها. | محدود شده است | ||
https://www.googleapis.com/auth/chat.messages.readonly | پیام ها و واکنش ها را در Google Chat مشاهده کنید. | محدود شده است | ||
https://www.googleapis.com/auth/chat.app.messages.readonly | پیام‌ها و واکنش‌ها را در Google Chat به‌عنوان یک برنامه چت مشاهده کنید. نیاز به تایید مدیر این محدوده فقط از تأیید اعتبار برنامه با حساب های خدمات پشتیبانی می کند. با استفاده از این محدوده نمی‌توانید با اعتبار کاربری یا با تفویض اختیار در سطح دامنه احراز هویت کنید. | محدود شده است | ||
| گوگل درایو | ||||
https://www.googleapis.com/auth/drive.file | هنگام استفاده از Google Picker API یا انتخابگر فایل برنامه، فایل‌های Drive جدید ایجاد کنید یا فایل‌های موجود را که با یک برنامه باز می‌کنید یا کاربر با یک برنامه به اشتراک می‌گذارد، تغییر دهید. | غیر حساس | ||
https://www.googleapis.com/auth/drive | همه فایل‌های Drive خود را مشاهده و مدیریت کنید. | محدود شده است | ||
https://www.googleapis.com/auth/drive.readonly | همه فایل‌های Drive خود را مشاهده و دانلود کنید. | محدود شده است | ||
https://www.googleapis.com/auth/drive.metadata | ابرداده فایل‌ها را در Drive خود مشاهده و مدیریت کنید. | محدود شده است | ||
https://www.googleapis.com/auth/drive.metadata.readonly | ابرداده فایل‌های موجود در Drive خود را مشاهده کنید. | محدود شده است | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created | به برنامه ها اجازه ایجاد، اصلاح و خواندن فراداده مربوط به فضاهای جلسه ایجاد شده توسط برنامه شما را بدهید. | حساس | ||
https://www.googleapis.com/auth/meetings.space.readonly | به برنامه‌ها اجازه دهید فراداده‌های مربوط به هر فضای جلسه‌ای را که کاربر به آن دسترسی دارد بخواند. | حساس | ||
ستون Usage در جدول قبل حساسیت هر محدوده را با توجه به تعاریف زیر نشان می دهد:
غیر حساس : این حوزه‌ها کوچکترین محدوده دسترسی مجوز را ارائه می‌کنند و فقط به تأیید اولیه برنامه نیاز دارند. برای کسب اطلاعات در مورد این الزام، به الزامات تأیید مراجعه کنید.
حساس : این حوزه‌ها دسترسی به داده‌های کاربر Google خاص را که توسط کاربر برای برنامه شما مجاز است، فراهم می‌کنند. از شما می‌خواهد تا از تأیید برنامه اضافی عبور کنید. برای اطلاعات در مورد این نیاز، به الزامات محدوده حساس و محدود مراجعه کنید.
محدود شده : این حوزه‌ها دسترسی گسترده‌ای به داده‌های کاربر Google را فراهم می‌کنند و از شما می‌خواهند که یک فرآیند تأیید دامنه محدود را طی کنید. برای کسب اطلاعات در مورد این الزام، به خدمات Google API مراجعه کنید: خط‌مشی داده‌های کاربر و الزامات اضافی برای محدوده‌های API خاص . اگر داده‌های محدوده محدود را روی سرورها ذخیره می‌کنید (یا ارسال می‌کنید)، پس باید ارزیابی امنیتی را انجام دهید.
اگر برنامه شما نیاز به دسترسی به سایر APIهای Google دارد، می‌توانید آن محدوده‌ها را نیز اضافه کنید. برای اطلاعات بیشتر در مورد دامنه های Google API، به استفاده از OAuth 2.0 برای دسترسی به Google API مراجعه کنید.
برای اطلاعات بیشتر درباره حوزه‌های خاص OAuth 2.0، به OAuth 2.0 Scopes برای Google API مراجعه کنید.
تأیید OAuth
استفاده از محدوده‌های خاص OAuth ممکن است مستلزم این باشد که برنامه شما از طریق مرکز راهنمایی تأیید برنامه OAuth ادامه یابد. سؤالات متداول برنامه OAuth را بخوانید تا مشخص کنید برنامه شما چه زمانی باید تأیید شود و چه نوع تأییدیه لازم است. همچنین به شرایط خدمات Google Drive مراجعه کنید.
انواع احراز هویت مورد نیاز
این بخش توضیح می‌دهد که کدام نوع احراز هویت مورد نیاز یا پشتیبانی می‌شود، و حوزه‌های پشتیبانی شده برای هر روش Google Workspace Events API را ارائه می‌دهد.
برای اشتراک در رویدادهای Google Chat، Google Workspace Events API از احراز هویت کاربر و برنامه برای فراخوانی برخی از روش‌های آن پشتیبانی می‌کند. اگر یک متد API از هر دو اعتبارنامه پشتیبانی می‌کند، نوع اعتبار استفاده شده در تماس بر نتیجه بازگشتی تأثیر می‌گذارد. به عنوان مثال، اگر متد subscriptions.list را با احراز هویت کاربر فراخوانی کنید، API فهرستی از اشتراک‌ها را برمی‌گرداند که کاربر احراز هویت شده می‌تواند به آنها دسترسی داشته باشد. اگر از احراز هویت برنامه استفاده می‌کنید، API فهرستی از اشتراک‌ها را که برنامه می‌تواند به آنها دسترسی داشته باشد، برمی‌گرداند. برای کسب اطلاعات بیشتر در مورد انواع احراز هویت Chat، به تأیید اعتبار و مجوز برنامه‌های Chat و درخواست‌های Google Chat API مراجعه کنید.
جدول زیر نشان می‌دهد که کدام حوزه‌ها و انواع احراز هویت برای هر روش Google Workspace Events API مورد نیاز یا پشتیبانی می‌شود:
| روش | احراز هویت کاربر مورد نیاز یا پشتیبانی می شود | تأیید اعتبار برنامه پشتیبانی می‌شود (فقط برنامه‌های چت Google) | دامنه مجوز پشتیبانی می شود | |
|---|---|---|---|---|
| یک اشتراک ایجاد کنید | - | با احراز هویت کاربر، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
پیش‌نمایش برنامه‌نویس : با احراز هویت برنامه و تأیید سرپرست (فقط برنامه‌های گپ Google)، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
| ||
| اشتراک دریافت کنید | با احراز هویت کاربر، این روش به یک محدوده نیاز دارد که حداقل یک نوع رویداد را برای اشتراک پشتیبانی کند . با احراز هویت برنامه (فقط برنامه‌های چت Google):
| |||
| فهرست اشتراک ها | با احراز هویت کاربر، این روش به یک محدوده نیاز دارد که حداقل یک نوع رویداد را برای اشتراک پشتیبانی کند . با احراز هویت برنامه (فقط برنامه‌های چت Google):
| |||
| اشتراک را به روز کنید | - | با احراز هویت کاربر، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
پیش‌نمایش برنامه‌نویس : با احراز هویت برنامه و تأیید سرپرست (فقط برنامه‌های گپ Google)، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
| ||
| اشتراک را دوباره فعال کنید | - | با احراز هویت کاربر، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
پیش‌نمایش برنامه‌نویس : با احراز هویت برنامه و تأیید سرپرست (فقط برنامه‌های گپ Google)، به یک محدوده پشتیبانی شده برای هر نوع رویداد نیاز دارد:
| ||
| اشتراک را حذف کنید | با احراز هویت کاربر، این روش به یک محدوده نیاز دارد که حداقل یک نوع رویداد را برای اشتراک پشتیبانی کند . با احراز هویت برنامه (فقط برنامه‌های چت Google):
| |||
دامنه بر اساس نوع رویداد
هنگامی که با استفاده از احراز هویت کاربر با Google Workspace Events API تماس می‌گیرید، باید یک یا چند محدوده را مشخص کنید که با انواع رویدادهای اشتراک مطابقت دارد.
جدول زیر نشان می دهد که کدام حوزه مجوز برای هر نوع رویداد پشتیبانی می شود:
| رویدادها | انواع رویداد | دامنه مجوز پشتیبانی می شود | ||||||
|---|---|---|---|---|---|---|---|---|
| چت گوگل | ||||||||
| یک پیام پست شده یا به روز می شود. |
| با احراز هویت کاربر :
| ||||||
| یک واکنش اضافه یا حذف می شود یا چندین واکنش تغییر می کند. |
|
| ||||||
| یک عضویت ایجاد، به‌روزرسانی یا حذف می‌شود یا چندین عضویت تغییر می‌کنند. |
| با احراز هویت کاربر :
| ||||||
| یک فضای به روز یا حذف می شود. |
| با احراز هویت کاربر :
| ||||||
| گوگل درایو | ||||||||
| یک فایل ایجاد می شود، تغییر می کند، منتقل می شود، حذف می شود، حذف می شود یا از سطل زباله حذف می شود. |
|
| ||||||
| یک پیشنهاد دسترسی روی یک فایل ایجاد یا حل می شود. |
|
| ||||||
| Google Meet | ||||||||
| یک کنفرانس شروع یا پایان می یابد. |
|
| ||||||
| یک شرکت کننده به یک کنفرانس می پیوندد یا از آن خارج می شود. |
|
| ||||||
| ضبط ایجاد شد. |
|
| ||||||
| رونوشت ایجاد شد. |
|
| ||||||