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

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

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

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

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

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

پیش نیازها

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

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

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

  2. نوع کاربری برنامه خود را انتخاب کنید، سپس روی ایجاد کلیک کنید.
  3. فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.

  4. اگر برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، روی Add or Remove Scopes کلیک کنید. ما بهترین روش های زیر را هنگام انتخاب محدوده توصیه می کنیم:

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

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

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

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

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

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

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

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

3. دامنه ها را پیکربندی کنید

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

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

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

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

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

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

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

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

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

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

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

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

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

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

،

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

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

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

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

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

پیش نیازها

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

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

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

  2. نوع کاربری برنامه خود را انتخاب کنید، سپس روی ایجاد کلیک کنید.
  3. فرم ثبت نام برنامه را تکمیل کنید، سپس روی ذخیره و ادامه کلیک کنید.

  4. اگر برنامه‌ای را برای استفاده خارج از سازمان Google Workspace خود ایجاد می‌کنید، روی Add or Remove Scopes کلیک کنید. ما بهترین روش های زیر را هنگام انتخاب محدوده توصیه می کنیم:

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

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

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

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

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

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

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

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

3. دامنه ها را پیکربندی کنید

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

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

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

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

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

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

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

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

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

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

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

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

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

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