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

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

OAuth 2.0 را برای مجوز پیکربندی کنید

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

دامنه های API Docs

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

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

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

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

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

ستون Usage در جدول حساسیت هر محدوده را با توجه به تعاریف زیر نشان می دهد:

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

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

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

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

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