این سند حاوی اطلاعات مجوز و احراز هویت مخصوص Gmail API است. قبل از خواندن این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در اطلاعات مربوط به احراز هویت و مجوز مطالعه کنید.
OAuth 2.0 را برای مجوز پیکربندی کنید
صفحه رضایت OAuth را پیکربندی کنید و دامنه ها را انتخاب کنید تا مشخص کنید چه اطلاعاتی برای کاربران و بازبینان برنامه نمایش داده می شود و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.
دامنه های Gmail API
برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید محدوده های مجوز را شناسایی و اعلام کنید. محدوده مجوز یک رشته URI OAuth 2.0 است که حاوی نام برنامه Google Workspace، نوع داده‌هایی است که به آن دسترسی دارد و سطح دسترسی. Scopes درخواست‌های برنامه شما برای کار با داده‌های Google Workspace، از جمله داده‌های حساب Google کاربران است.
هنگامی که برنامه شما نصب می شود، از کاربر خواسته می شود تا محدوده های مورد استفاده برنامه را تأیید کند. به طور کلی، شما باید محدودترین محدوده ممکن را انتخاب کنید و از درخواست دامنه هایی که برنامه شما به آن نیاز ندارد اجتناب کنید. کاربران با سهولت بیشتری به محدوده‌های محدود و به وضوح توضیح داده شده دسترسی می‌دهند.
Gmail API از حوزه های زیر پشتیبانی می کند:
| کد محدوده | توضیحات | استفاده |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose | هنگام تعامل با افزونه، پیش نویس ها را مدیریت کنید و ایمیل ارسال کنید. | غیر حساس |
https://www.googleapis.com/auth/gmail.addons.current.message.action | هنگام تعامل با افزونه، پیام‌های ایمیل خود را مشاهده کنید. | غیر حساس |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata | هنگامی که افزونه در حال اجرا است، فراداده پیام ایمیل خود را مشاهده کنید. | حساس |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly | هنگامی که افزونه در حال اجرا است، پیام های ایمیل خود را مشاهده کنید. | حساس |
https://www.googleapis.com/auth/gmail.labels | فقط برچسب‌ها را بسازید، بخوانید، به‌روزرسانی کنید و حذف کنید. | غیر حساس |
https://www.googleapis.com/auth/gmail.send | فقط پیام بفرست هیچ امتیاز خواندن یا تغییر در صندوق پستی وجود ندارد. | حساس |
https://www.googleapis.com/auth/gmail.readonly | همه منابع و ابرداده های آنها را بخوانید - بدون عملیات نوشتن. | محدود شده است |
https://www.googleapis.com/auth/gmail.compose | پیش نویس ها را بسازید، بخوانید، به روز کنید و حذف کنید. پیام ها و پیش نویس ها را ارسال کنید. | محدود شده است |
https://www.googleapis.com/auth/gmail.insert | فقط پیام ها را وارد و وارد کنید. | محدود شده است |
https://www.googleapis.com/auth/gmail.modify | همه عملیات خواندن/نوشتن به جز حذف فوری و دائمی رشته ها و پیام ها، دور زدن سطل زباله. | محدود شده است |
https://www.googleapis.com/auth/gmail.metadata | فراداده منابع از جمله برچسب‌ها، سوابق سابقه و سرصفحه‌های پیام ایمیل را بخوانید، اما متن پیام یا پیوست‌ها را بخوانید. | محدود شده است |
https://www.googleapis.com/auth/gmail.settings.basic | تنظیمات اصلی ایمیل را مدیریت کنید | محدود شده است |
https://www.googleapis.com/auth/gmail.settings.sharing | تنظیمات ایمیل حساس، از جمله قوانین بازارسال و نام های مستعار را مدیریت کنید. توجه: عملیات محافظت شده توسط این محدوده فقط به استفاده اداری محدود می شود. آنها فقط برای مشتریان Google Workspace با استفاده از یک حساب سرویس با تفویض اختیار در سطح دامنه در دسترس هستند. | محدود شده است |
https://mail.google.com/ | دسترسی کامل به صندوق‌های پستی حساب، از جمله حذف دائمی رشته‌ها و پیام‌ها، این محدوده فقط در صورتی درخواست می‌شود که برنامه شما نیاز به حذف فوری و دائمی رشته‌ها و پیام‌ها و دور زدن سطل زباله داشته باشد. تمام اقدامات دیگر را می توان با دامنه های مجاز کمتر انجام داد. | محدود شده است |
ستون Usage در جدول بالا حساسیت هر محدوده را با توجه به تعاریف زیر نشان می دهد:
غیر حساس ——این محدوده ها کوچکترین حوزه دسترسی مجوز را فراهم می کنند و فقط به تأیید اولیه برنامه نیاز دارند. برای کسب اطلاعات در مورد این الزام، به مراحل آماده شدن برای تأیید مراجعه کنید.
حساس — این محدوده‌ها اجازه دسترسی به داده‌های کاربر Google را می‌دهند و به یک فرآیند تأیید دامنه حساس نیاز دارند. برای کسب اطلاعات در مورد این نیاز، به خدمات Google API مراجعه کنید: خط مشی داده کاربر . این محدوده ها نیازی به ارزیابی امنیتی ندارند.
محدود - این محدوده‌ها دسترسی گسترده‌ای به داده‌های کاربر Google را فراهم می‌کنند و از شما می‌خواهند که یک فرآیند تأیید محدوده محدود را طی کنید. برای کسب اطلاعات در مورد این نیاز، به خدمات Google API مراجعه کنید: خط‌مشی داده‌های کاربر و الزامات اضافی برای محدوده‌های API خاص . اگر داده‌های محدوده محدود را روی سرورها ذخیره می‌کنید (یا ارسال می‌کنید)، پس باید یک ارزیابی امنیتی انجام دهید.
اطلاعات اضافی که بر استفاده و دسترسی شما به APIهای Gmail زمانی که درخواست دسترسی به داده‌های کاربر را دارید می‌توانید در خط‌مشی برنامه‌نویس و داده‌های کاربر سرویس‌های API Gmail بیابید.
اگر برنامه شما نیاز به دسترسی به سایر APIهای Google دارد، می‌توانید آن محدوده‌ها را نیز اضافه کنید. برای اطلاعات بیشتر در مورد دامنه های Google API، به استفاده از OAuth 2.0 برای دسترسی به Google API مراجعه کنید.
تأیید OAuth
استفاده از محدوده‌های حساس OAuth ممکن است مستلزم این باشد که برنامه شما فرآیند تأیید OAuth Google را طی کند. سؤالات متداول تأیید OAuth را بخوانید تا مشخص کنید برنامه شما چه زمانی باید تأیید شود و چه نوع تأییدیه لازم است. همچنین به خدمات Google API: خط مشی داده های کاربر مراجعه کنید.