دامنه‌های API کاربرگ‌نگار Google را انتخاب کنید

این سند حاوی اطلاعات مربوط به مجوز و احراز هویت مختص API گوگل شیت است. قبل از مطالعه این سند، حتماً اطلاعات عمومی احراز هویت و مجوز Google Workspace را در بخش «درباره احراز هویت و مجوز بیشتر بدانید» مطالعه کنید.

توجه داشته باشید که محدوده‌های API مربوط به Sheets روی یک فایل صفحه گسترده اعمال می‌شوند و نمی‌توانند به یک صفحه خاص محدود شوند. برای جلوگیری از تغییر یک صفحه، از ProtectedRange برای تعریف یک سلول یا محدوده‌ای از سلول‌ها که قابل ویرایش نیستند استفاده کنید. برای مثال، به Named و protected ranges مراجعه کنید.

پیکربندی OAuth 2.0 برای احراز هویت

صفحه رضایت OAuth را پیکربندی کنید و محدوده‌هایی را برای تعریف اطلاعات نمایش داده شده به کاربران و بررسی‌کنندگان برنامه انتخاب کنید و برنامه خود را ثبت کنید تا بتوانید بعداً آن را منتشر کنید.

دامنه‌های API صفحات

برای تعریف سطح دسترسی اعطا شده به برنامه خود، باید حوزه‌های مجوز را شناسایی و اعلام کنید. حوزه مجوز، یک رشته URI از نوع OAuth 2.0 است که شامل نام برنامه Google Workspace، نوع داده‌هایی که به آنها دسترسی دارد و سطح دسترسی است. حوزه‌ها، درخواست‌های برنامه شما برای کار با داده‌های Google Workspace، از جمله داده‌های حساب Google کاربران، هستند.

وقتی برنامه شما نصب می‌شود، از کاربر خواسته می‌شود تا محدوده‌های مورد استفاده برنامه را اعتبارسنجی کند. به طور کلی، شما باید محدوده‌ای را انتخاب کنید که بیشترین تمرکز را داشته باشد و از درخواست محدوده‌هایی که برنامه شما به آنها نیاز ندارد، خودداری کنید. کاربران راحت‌تر به محدوده‌های محدود و واضح دسترسی می‌دهند.

در صورت امکان، توصیه می‌کنیم از محدوده‌های غیرحساس استفاده کنید زیرا محدوده دسترسی به ازای هر فایل را اعطا می‌کند و دسترسی به ویژگی‌های خاص مورد نیاز یک برنامه را محدود می‌کند.

API مربوط به Sheets از حوزه‌های زیر پشتیبانی می‌کند:

کد محدوده توضیحات کاربرد
https://www.googleapis.com/auth/spreadsheets تمام صفحات گسترده Google Sheets خود را ببینید، ویرایش، ایجاد و حذف کنید. حساس
https://www.googleapis.com/auth/spreadsheets.readonly تمام صفحات گسترده Google Sheets خود را مشاهده کنید. حساس
https://www.googleapis.com/auth/drive.file فقط فایل‌های خاص گوگل درایوی را که با این برنامه استفاده می‌کنید، ببینید، ویرایش، ایجاد و حذف کنید. توصیه شده
غیر حساس
https://www.googleapis.com/auth/drive تمام فایل‌های گوگل درایو خود را ببینید، ویرایش کنید، ایجاد کنید و حذف کنید. محدود شده
https://www.googleapis.com/auth/drive.readonly تمام فایل‌های گوگل درایو خود را ببینید و دانلود کنید. محدود شده

ستون «استفاده» در جدول، حساسیت هر محدوده را طبق تعاریف زیر نشان می‌دهد:

  • غیرحساس : این محدوده‌ها کوچکترین محدوده دسترسی مجوز را ارائه می‌دهند و فقط به تأیید اولیه برنامه نیاز دارند. برای اطلاعات بیشتر در مورد این الزام، به ارسال برنامه خود برای تأیید مراجعه کنید.

  • حساس : این محدوده‌ها دسترسی به داده‌های خاص کاربر گوگل را که توسط کاربر برای برنامه شما مجاز شده است، فراهم می‌کنند. این امر مستلزم آن است که شما تأیید هویت برنامه را انجام دهید. برای اطلاعات بیشتر در مورد این الزام، به الزامات محدوده حساس و محدود مراجعه کنید.

  • محدود : این محدوده‌ها دسترسی گسترده‌ای به داده‌های کاربر گوگل ارائه می‌دهند و شما را ملزم به طی کردن یک فرآیند تأیید محدوده محدود می‌کنند. برای اطلاعات بیشتر در مورد این الزام، به سیاست داده‌های کاربر سرویس‌های API گوگل و الزامات اضافی برای محدوده‌های خاص API مراجعه کنید. اگر داده‌های محدوده محدود را روی سرورها ذخیره می‌کنید (یا منتقل می‌کنید)، باید ارزیابی امنیتی را انجام دهید.

اگر برنامه شما نیاز به دسترسی به هر API گوگل دیگری دارد، می‌توانید آن محدوده‌ها را نیز اضافه کنید. برای اطلاعات بیشتر در مورد محدوده‌های API گوگل، به بخش «استفاده از OAuth 2.0 برای دسترسی به APIهای گوگل» مراجعه کنید.

برای اطلاعات بیشتر در مورد حوزه‌های خاص OAuth 2.0، به حوزه‌های OAuth 2.0 برای APIهای گوگل مراجعه کنید.