OAuth را پیکربندی کنید

هنگامی که برنامه خود را منتشر می کنید، سه کار اصلی برای احراز هویت و مجوز وجود دارد:

  1. صفحه رضایت OAuth را پر کنید .
  2. اعتبار OAuth 2.0 خود را ایجاد کنید .
  3. برنامه خود را برای تأیید OAuth ارسال کنید .

دامنه های OAuth را درک کنید

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

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

لیست کامل دامنه های OAuth را که برنامه شما به آن نیاز دارد ارائه دهید. محدوده‌هایی که به هر مکان اضافه می‌کنید باید مطابقت داشته باشند و به روش‌های زیر استفاده می‌شوند:

  • دامنه های اضافه شده به صفحه رضایت OAuth برای تأیید OAuth استفاده می شود.

  • دامنه‌های اضافه‌شده به Google Workspace Marketplace SDK برای نصب‌های دامنه و تکی استفاده می‌شود تا برنامه شما در هنگام نصب از Google Workspace Marketplace مجاز شود.

  • دامنه‌های اضافه شده به مانیفست برای عملکرد صحیح برنامه شما ضروری است.

برای مثال، اگر برنامه‌ای را منتشر می‌کنید که شامل افزونه Google Sheets و Google Docs است، مانیفست Google Apps Script هر افزونه فقط شامل دامنه‌های خاص آن افزونه می‌شود. در پروژه Google Cloud شما، صفحه رضایت OAuth و SDK Marketplace شامل محدوده هر دو افزونه است.

دامنه های OAuth تأیید نشده را برطرف کنید

اگر یک برنامه جدید، یک پیش‌نویس ذخیره‌شده یا برنامه عمومی منتشر شده با دامنه‌های حساس یا محدود تأیید نشده دارید، هنگام ویرایش برنامه در Marketplace SDK، پیام خطای زیر را مشاهده می‌کنید:

OAuth verification is required for sensitive or restricted scopes. You can still save your app as a draft, but you're not able to publish your draft app listing.

برای اطلاعات بیشتر، به تعیین سطح دسترسی مورد نیاز برنامه مراجعه کنید.

برای رفع این خطا می توانید کارهای زیر را انجام دهید:

  • تغییراتی را در فهرست برنامه با دامنه‌های حساس یا محدود تأیید نشده ایجاد کنید و فهرست را به‌عنوان پیش‌نویس ذخیره کنید.

  • زمانی که هیچ حوزه حساس یا محدود تأیید نشده جدیدی اضافه نشد، برنامه را منتشر کنید.

  • زمانی که فقط محدوده‌های حساس یا محدود تأیید نشده را حذف می‌کنید، برنامه را منتشر کنید.

برای برخی از راه‌حل‌ها، ممکن است صفحه «برنامه تأیید نشده» به کاربران نشان داده شود. برای اطلاعات بیشتر، برنامه‌های تأیید نشده را ببینید.

برای رفع این خطا، برنامه خود را برای تأیید OAuth ارسال کنید.

پیش نیازها

صفحه رضایت OAuth پیامی است که به کاربران می‌گوید چه کسی درخواست دسترسی به داده‌های خود را دارد و کاربران به چه نوع داده‌هایی اجازه دسترسی به برنامه شما را می‌دهند.

  1. در کنسول Google Cloud، به > بروید > برندسازی

    به برندینگ بروید

  2. اگر قبلاً آن را پیکربندی کرده اید ، می توانید تنظیمات صفحه رضایت OAuth زیر را در نام تجاری ، مخاطب و دسترسی به داده پیکربندی کنید. اگر پیامی دیدید که می گوید هنوز پیکربندی نشده است ، روی شروع کلیک کنید:
    1. در زیر اطلاعات برنامه ، در نام برنامه ، نام برنامه را وارد کنید.
    2. در ایمیل پشتیبانی کاربر ، آدرس ایمیل پشتیبانی را انتخاب کنید که در صورت داشتن رضایت، کاربران بتوانند با شما تماس بگیرند.
    3. روی Next کلیک کنید.
    4. در بخش مخاطبان ، نوع کاربری برنامه خود را انتخاب کنید.
    5. روی Next کلیک کنید.
    6. در قسمت اطلاعات تماس ، آدرس ایمیلی را وارد کنید که در آن می‌توانید از هرگونه تغییر در پروژه خود مطلع شوید.
    7. روی Next کلیک کنید.
    8. در قسمت پایان ، خط‌مشی داده‌های کاربر سرویس‌های API Google را مرور کنید و در صورت موافقت، من با خدمات Google API موافقم: خط‌مشی داده‌های کاربر را انتخاب کنید.
    9. روی Continue کلیک کنید.
    10. روی ایجاد کلیک کنید.
    11. اگر خارجی را برای نوع کاربر انتخاب کرده اید، کاربران آزمایشی را اضافه کنید:
      1. روی مخاطب کلیک کنید.
      2. در بخش تست کاربران ، روی افزودن کاربران کلیک کنید.
      3. آدرس ایمیل خود و سایر کاربران آزمایشی مجاز را وارد کنید، سپس روی ذخیره کلیک کنید.

  3. اگر برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، روی دسترسی به داده > افزودن یا حذف دامنه‌ها کلیک کنید. ما بهترین روش های زیر را هنگام انتخاب محدوده توصیه می کنیم:

    • محدوده هایی را انتخاب کنید که حداقل سطح دسترسی مورد نیاز برنامه شما را فراهم می کند. برای فهرستی از حوزه‌های موجود، OAuth 2.0 Scopes for Google APIs را ببینید.
    • محدوده های فهرست شده در هر یک از سه بخش را مرور کنید: محدوده های غیر حساس، محدوده های حساس، و محدوده های محدود. برای هر حوزه‌ای که در بخش‌های «حوزه‌های حساس شما» یا «حوزه‌های محدود شما» فهرست شده‌اند، سعی کنید محدوده‌های غیرحساس جایگزین را شناسایی کنید تا از بررسی‌های اضافی غیرضروری خودداری کنید.
    • برخی از حوزه‌ها نیاز به بررسی بیشتر توسط Google دارند. برای برنامه‌هایی که فقط به صورت داخلی توسط سازمان Google Workspace شما استفاده می‌شوند، دامنه‌ها در صفحه رضایت فهرست نشده‌اند و استفاده از محدوده‌های محدود یا حساس نیازی به بررسی بیشتر توسط Google ندارد. برای اطلاعات بیشتر، به دسته‌های محدوده مراجعه کنید.
  4. پس از انتخاب محدوده های مورد نیاز برنامه، روی ذخیره کلیک کنید.

برای اطلاعات بیشتر درباره پیکربندی رضایت OAuth، به شروع به کار با آن مراجعه کنید .

2. اعتبار OAuth 2.0 خود را ایجاد کنید

بسته به نحوه ساخت برنامه خود، دو روش مختلف برای ایجاد اعتبارنامه OAuth 2.0 وجود دارد.

اگر برنامه خود را در Apps Script ساخته اید

پروژه Apps Script خود را از پروژه پیش‌فرض Cloud به پروژه جدید و استاندارد خود تغییر دهید. برای اطلاعات بیشتر، جابجایی به پروژه استاندارد Cloud متفاوت را ببینید.

پس از اینکه پروژه Apps Script خود را با پروژه Cloud مرتبط کردید، اعتبار OAuth 2.0 شما به طور خودکار ایجاد می شود.

اگر از Apps Script برای ساخت برنامه خود استفاده نکرده اید

برای ایجاد اعتبارنامه OAuth 2.0، به شناسه مشتری OAuth مراجعه کنید.

3. برای تأیید OAuth ارسال کنید (فقط برنامه‌های عمومی)

اگر برنامه شما از APIهای Google برای دسترسی به داده‌های کاربر Google استفاده می‌کند، ممکن است قبل از انتشار برنامه‌تان تحت فرآیند تأیید قرار گیرد.

قبل از ارسال

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

برای مثال، برای ایجاد یک افزونه Google Classroom، باید با استفاده از مراحل پیکربندی برنامه خود در Google Workspace Marketplace SDK، یک فهرست پیش‌نویس برنامه در SDK Marketplace ایجاد کنید. سپس می‌توانید از فهرست پیش‌نویس برنامه برای ایجاد ویدیوی آزمایشی مورد نیاز برای تأیید OAuth استفاده کنید. پس از تأیید، می توانید فهرست پیش نویس برنامه خود را برای بررسی برنامه ارسال کنید.

برای مروری بر مراحل ارسال به انتشار برنامه خود مراجعه کنید

بررسی تأیید OAuth

اگر برنامه شما از حوزه‌های حساس یا محدود استفاده می‌کند، باید تحت فرآیند بررسی تأیید OAuth قرار گیرد.

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

  • اگر برنامه شما از محدوده‌های محدود استفاده می‌کند، ممکن است نیاز به ارزیابی امنیتی داشته باشد.

  • برای اطلاعات بیشتر، به مرکز راهنمایی تأیید برنامه OAuth مراجعه کنید.

برای ارسال برای تأیید، مراحل زیر را دنبال کنید:

  1. در کنسول Google Cloud، به منو > APIs & Services > صفحه رضایت OAuth بروید.

    به صفحه رضایت OAuth بروید

  2. روی Project Selector کلیک کنید و پروژه خود را انتخاب کنید.
  3. روی ویرایش برنامه کلیک کنید
  4. اطلاعات مورد نیاز را وارد کنید و روی ارسال برای تأیید کلیک کنید.
  5. در کادر گفتگوی تأیید صحت ، توجیهات مناسب را وارد کنید و سپس روی ارسال کلیک کنید تا فرآیند تأیید شروع شود.

اگر برنامه خود را برای استفاده از حوزه های مختلف حساس یا محدود کننده به روز می کنید، باید دوباره برنامه خود را برای تأیید OAuth ارسال کنید. لازم نیست دوباره آن را برای بررسی برنامه ارسال کنید.

چگونه تأیید OAuth با بررسی برنامه متفاوت است

تأیید OAuth فرآیندی جدا از بررسی برنامه است. این برنامه بر اطمینان از اینکه صفحه رضایت شما دقیقاً هویت و هدف برنامه شما را نشان می دهد تمرکز می کند و مطمئن می شود که برنامه شما از داده های کاربر سوء استفاده نمی کند. تا زمانی که تأیید OAuth برنامه شما کامل نشود، فهرست برنامه شما تأیید نمی‌شود. برای اطلاعات بیشتر در مورد تأیید OAuth، سؤالات متداول OAuth را ببینید.

بررسی برنامه بر اطلاعاتی که در Google Workspace Marketplace SDK ارائه می‌دهید و ویژگی‌ها و قابلیت استفاده برنامه شما متمرکز است. برای کسب اطلاعات بیشتر در مورد معیارهای بررسی برنامه، به روند بررسی برنامه و الزامات مربوط به Google Workspace Marketplace مراجعه کنید.