همه برنامههایی که به APIهای گوگل دسترسی دارند باید تأیید کنند که هویت و قصد خود را به طور دقیق مطابق با خطمشی دادههای کاربر سرویسهای API گوگل نشان میدهند. برای محافظت از شما و کاربران مشترک گوگل و برنامه شما، ممکن است صفحه رضایت و برنامه شما نیاز به تأیید گوگل داشته باشد.
اگر برنامه شما تمام معیارهای زیر را داشته باشد، نیاز به تأیید دارد:
- در Google API Console، پیکربندی برنامه شما برای نوع کاربری External تنظیم شده است. این بدان معناست که برنامه شما برای هر کاربری که دارای حساب گوگل باشد، در دسترس است.
- شما میخواهید برنامهتان یک لوگو یا نام را در صفحه رضایت OAuth نمایش دهد.
اگر اطلاعات برند تأیید شده را وارد کنید، میتوانید احتمال اینکه کاربر برند شما را بشناسد و تصمیم به اعطای دسترسی به برنامه شما بگیرد را افزایش دهید. اطلاعات برند تأیید شده همچنین میتواند منجر به لغو کمتر دسترسی در مراحل بعدی شود، زمانی که کاربر یا مدیر Google Workspace برنامهها و سرویسهای شخص ثالث دارای دسترسی به حساب را بررسی میکند . فرآیند تأیید برند صفحه رضایت OAuth معمولاً ۲-۳ روز کاری پس از ارسال برای تأیید طول میکشد.
اگر درخواست خود را برای تأیید برند ارسال نکنید، ممکن است منجر به کاهش اعتماد کاربران به درخواست شما برای دسترسی به دادههایشان شود، که میتواند منجر به مجوزهای کمتر برای کاربران و لغو مجوزهای بیشتر در آینده شود.
صفحه رضایت OAuth
صفحه رضایت به کاربران میگوید چه کسی درخواست دسترسی به دادههای آنها را دارد و برنامه شما باید به چه نوع دادههایی از طرف آنها دسترسی داشته باشد، همانطور که در کادر ۲ شکل ۱ برجسته شده است.
وقتی برنامه شما فرآیند تأیید برند را طی میکند و تأییدیه دریافت میکند، احتمال اینکه حساب کاربری که مجوز را اعطا میکند، سیاستهای هویت و دادههای کاربر برنامه شما را به وضوح درک کند، بیشتر است. این درک واضح میتواند احتمال تأیید درخواستهای شما توسط دارنده حساب را افزایش دهد و هنگام بررسی لغوهای احتمالی در صفحه حساب گوگل خود، دسترسی را حفظ کند. محتوایی که در OAuth پیکربندی میکنید Branding page در Cloud Console اجزای زیر را پر میکند:
- نام و لوگوی اپلیکیشن شما (مطابق با کادر ۱ در شکل ۱)
- ایمیل پشتیبانی کاربر شما، که پس از انتخاب نام برنامه شما نمایش داده میشود (کادر ۲ از شکل ۱)
- پیوندهایی به سیاست حفظ حریم خصوصی و شرایط خدمات شما (کادر ۳ از شکل ۱)
دامنههای مجاز
به عنوان بخشی از فرآیند تأیید برند، گوگل نیاز به تأیید تمام دامنههایی دارد که با صفحه رضایت OAuth و اعتبارنامههای یک برنامه مرتبط هستند. ما از شما میخواهیم که مؤلفه دامنه موجود برای ثبت با پسوند عمومی را تأیید کنید: " دامنه خصوصی برتر ". به عنوان مثال، یک صفحه رضایت OAuth که با صفحه اصلی برنامه https://sub.example.com/product پیکربندی شده است، از دارنده حساب میخواهد مالکیت دامنه example.com را تأیید کند.
بخش دامنههای مجاز در ویرایشگر صفحه رضایت OAuth باید شامل دامنههای خصوصی برتر باشد که در URI های بخش دامنه برنامه استفاده میشوند. این دامنهها شامل صفحه اصلی برنامه، سیاست حفظ حریم خصوصی و شرایط خدمات میشوند. بخش دامنههای مجاز همچنین باید شامل URI های تغییر مسیر و/یا ریشههای جاوا اسکریپت مجاز در انواع کلاینت OAuth "برنامه وب" شما باشد.
مالکیت دامنههای مجاز خود را با استفاده از کنسول جستجوی گوگل تأیید کنید. یک حساب گوگل با مجوزهای مالکیت برای یک دامنه باید با آن مرتبط باشد API Console پروژهای که از آن دامنه مجاز استفاده میکند. برای اطلاعات بیشتر در مورد تأیید دامنه در کنسول جستجوی گوگل، به بخش «تأیید مالکیت سایت» مراجعه کنید.
مراحل آماده سازی برای تأیید
همه برنامههایی که از APIهای گوگل برای درخواست دسترسی به دادهها استفاده میکنند، باید مراحل زیر را برای تکمیل تأیید برند انجام دهند:
- تأیید کنید که برنامه شما تحت هیچ یک از موارد استفاده در بخش استثنائات الزامات تأیید قرار نمیگیرد.
- مطمئن شوید که برنامه شما با الزامات برندسازی APIها یا محصول مرتبط مطابقت دارد. برای مثال، به دستورالعملهای برندسازی برای حوزههای ورود به سیستم گوگل مراجعه کنید.
- مالکیت دامنههای مجاز پروژه خود را در کنسول جستجوی گوگل تأیید کنید. از یک حساب گوگل مرتبط با دامنه خود استفاده کنید. API Console به عنوان مالک یا ویراستار، پروژه را مدیریت کنید.
- مطمئن شوید که تمام اطلاعات مربوط به برند در صفحه رضایت OAuth، مانند نام برنامه، ایمیل پشتیبانی، آدرس صفحه اصلی، آدرس سیاست حفظ حریم خصوصی و غیره، به طور دقیق هویت برنامه را نشان میدهند.
الزامات صفحه اصلی برنامه
مطمئن شوید که صفحه اصلی شما شرایط زیر را برآورده میکند:
- صفحه اصلی شما باید به صورت عمومی قابل دسترسی باشد و نه فقط برای کاربران وارد شده به سایت شما.
- ارتباط صفحه اصلی شما با اپلیکیشنی که در دست بررسی است باید کاملاً مشخص باشد.
- لینکهایی که به فهرست اپلیکیشن شما در گوگل پلی استور یا صفحه فیسبوک آن اشاره دارند، صفحات اصلی معتبری برای اپلیکیشن محسوب نمیشوند.
الزامات پیوند سیاست حفظ حریم خصوصی برنامه
مطمئن شوید که سیاست حفظ حریم خصوصی برنامه شما شرایط زیر را برآورده میکند:
- سیاست حفظ حریم خصوصی باید برای کاربران قابل مشاهده باشد، در همان دامنهای که صفحه اصلی برنامه شما قرار دارد، میزبانی شود و در صفحه رضایت OAuth برنامه به آن لینک داده شود. Google API Consoleتوجه داشته باشید که صفحه اصلی باید شامل شرحی از عملکرد برنامه و همچنین پیوندهایی به سیاست حفظ حریم خصوصی و شرایط خدمات اختیاری باشد.
- سیاست حفظ حریم خصوصی باید نحوه دسترسی، استفاده، ذخیره یا اشتراکگذاری دادههای کاربران گوگل توسط برنامه شما را افشا کند. شما باید استفاده خود از دادههای کاربران گوگل را به رویههایی که سیاست حفظ حریم خصوصی منتشر شده شما فاش میکند، محدود کنید.
نحوه ارسال برنامه برای تأیید
الف Google Cloud Console پروژه تمام شما را سازماندهی میکند Cloud Console منابع. یک پروژه شامل مجموعهای از حسابهای گوگل مرتبط است که مجوز انجام عملیات پروژه، مجموعهای از APIهای فعال و تنظیمات صورتحساب، احراز هویت و نظارت برای آن APIها را دارند. به عنوان مثال، یک پروژه میتواند شامل یک یا چند کلاینت OAuth باشد، APIها را برای استفاده توسط آن کلاینتها پیکربندی کند و یک صفحه رضایت OAuth را پیکربندی کند که قبل از اجازه دسترسی به برنامه شما به کاربران نشان داده میشود.
اگر هر یک از کلاینتهای OAuth شما برای تولید آماده نیستند، پیشنهاد میکنیم آنها را از پروژهای که درخواست تأیید دارد حذف کنید. میتوانید این کار را در Clients page.
برای ارسال جهت تأیید، مراحل زیر را دنبال کنید:
- مطمئن شوید که برنامه شما با شرایط خدمات APIهای گوگل و خطمشی دادههای کاربر سرویسهای API گوگل مطابقت دارد.
- نقشهای مالک و ویرایشگر حسابهای کاربری مرتبط با پروژه خود و همچنین ایمیل پشتیبانی کاربر و اطلاعات تماس توسعهدهنده صفحه رضایت OAuth خود را بهروز نگه دارید. Cloud Consoleاین تضمین میکند که اعضای صحیح تیم شما از هرگونه الزامات جدید مطلع میشوند.
- برو به Cloud Consoleمرکز تأیید OAuth
- روی دکمه انتخاب پروژه کلیک کنید.
در پنجرهی «انتخاب از» که ظاهر میشود، پروژهی خود را انتخاب کنید. اگر نمیتوانید پروژهی خود را پیدا کنید اما شناسهی پروژهی خود را میدانید، میتوانید در مرورگر خود یک URL با فرمت زیر ایجاد کنید:
https://console.developers.google.com/auth/branding?project=[PROJECT_ID]
به جای [PROJECT_ID] ، شناسه پروژه مورد نظر خود را وارد کنید.
- دکمه ویرایش برنامه را انتخاب کنید.
- اطلاعات لازم را در صفحه رضایتنامه OAuth وارد کنید و سپس دکمه ذخیره و ادامه را انتخاب کنید.
- از دکمهی «افزودن یا حذف محدودهها» برای اعلام تمام محدودههای درخواستی برنامهی خود استفاده کنید. مجموعهای اولیه از محدودههایی که برای ورود به سیستم با گوگل ضروری هستند، در بخش محدودههای غیرحساس از قبل پر شدهاند. محدودههای اضافه شده به عنوان غیرحساس طبقهبندی میشوند، sensitive, or restricted.
- حداکثر سه لینک به هرگونه مستندات مرتبط با ویژگیهای مرتبط در برنامه خود ارائه دهید.
هرگونه اطلاعات اضافی که در مراحل بعدی در مورد برنامه شما درخواست شد را ارائه دهید.
- اگر پیکربندی برنامهای که ارائه میدهید نیاز به تأیید دارد، میتوانید برنامه را برای تأیید ارسال کنید. فیلدهای مورد نیاز را پر کنید و سپس برای شروع فرآیند تأیید، روی ارسال کلیک کنید.
پس از ارسال برنامه، تیم اعتماد و ایمنی گوگل از طریق ایمیل هرگونه اطلاعات اضافی مورد نیاز یا مراحلی را که باید تکمیل کنید، پیگیری میکند. برای درخواست اطلاعات بیشتر، آدرسهای ایمیل خود را در بخش اطلاعات تماس توسعهدهنده و ایمیل پشتیبانی صفحه رضایت OAuth خود بررسی کنید. همچنین میتوانید صفحه صفحه رضایت OAuth پروژه خود را مشاهده کنید تا وضعیت فعلی بررسی پروژه خود را تأیید کنید، از جمله اینکه آیا روند بررسی در حین انتظار برای پاسخ شما متوقف شده است یا خیر.
استثنائات الزامات تأیید
اگر قرار است از برنامه شما در هر یک از سناریوهای شرح داده شده در بخشهای بعدی استفاده شود، نیازی به ارسال آن برای بررسی ندارید.
استفاده شخصی
یک مورد استفاده این است که اگر شما تنها کاربر برنامه خود هستید یا اگر برنامه شما توسط تعداد کمی از کاربران استفاده میشود که همه آنها را شخصاً میشناسید، شما و تعداد محدود کاربرانتان ممکن است با عبور از صفحه برنامه تأیید نشده و اعطای دسترسی حسابهای شخصی به برنامه خود، مشکلی نداشته باشید.
پروژههای مورد استفاده در سطوح توسعه، آزمایش یا مرحلهبندی
برای رعایت سیاستهای Google OAuth 2.0، توصیه میکنیم پروژههای مختلفی برای محیطهای آزمایش و تولید داشته باشید. توصیه میکنیم فقط در صورتی برنامه خود را برای تأیید ارسال کنید که میخواهید برنامهتان را برای هر کاربری که دارای حساب Google است، در دسترس قرار دهید. بنابراین، اگر برنامه شما در مراحل توسعه، آزمایش یا مرحلهبندی است، تأیید لازم نیست.
اگر برنامه شما در مراحل توسعه یا آزمایش است، میتوانید وضعیت انتشار را در حالت پیشفرض «در حال آزمایش» باقی بگذارید. این تنظیم به این معنی است که برنامه شما هنوز در حال توسعه است و فقط برای کاربرانی که به لیست کاربران آزمایشی اضافه میکنید، در دسترس است. شما باید لیست حسابهای گوگلی را که در توسعه یا آزمایش برنامه شما دخیل هستند، مدیریت کنید.
فقط دادههای متعلق به سرویس
اگر برنامه شما از یک حساب سرویس فقط برای دسترسی به دادههای خودش استفاده میکند و به هیچ داده کاربری (مرتبط با یک حساب Google) دسترسی ندارد، نیازی به ارسال برای تأیید ندارید.
برای درک اینکه حسابهای سرویس چیستند، به بخش حسابهای سرویس در مستندات Google Cloud مراجعه کنید. برای دستورالعملهای نحوه استفاده از یک حساب سرویس، به بخش استفاده از OAuth 2.0 برای برنامههای سرور به سرور مراجعه کنید.
فقط استفاده داخلی
این بدان معناست که برنامه فقط توسط افرادی که در سازمان Google Workspace یا Cloud Identity شما هستند استفاده میشود. این پروژه باید متعلق به سازمان باشد و صفحه رضایت OAuth آن باید برای نوع کاربر داخلی پیکربندی شود. در این حالت، ممکن است برنامه شما نیاز به تأیید مدیر سازمان داشته باشد. برای اطلاعات بیشتر، به ملاحظات بیشتر برای Google Workspace مراجعه کنید.
- درباره برنامههای عمومی و داخلی بیشتر بدانید.
- یاد بگیرید که چگونه برنامه خود را به عنوان برنامه داخلی در بخش سوالات متداول علامت گذاری کنید . چگونه میتوانم برنامهام را به عنوان برنامه فقط داخلی علامت گذاری کنم؟
نصب در سطح دامنه
اگر قصد دارید برنامهتان فقط کاربران یک سازمان Google Workspace یا Cloud Identity را هدف قرار دهد و همیشه از نصب در سطح دامنه استفاده کند، برنامه شما نیازی به تأیید برند نخواهد داشت. با این حال، اگر برنامه شما از حوزههای محدود یا حساس استفاده میکند، تأیید برنامه الزامی است. دلیل این امر این است که نصب در سطح دامنه به مدیر دامنه اجازه میدهد تا به برنامههای شخص ثالث و داخلی اجازه دسترسی به دادههای کاربران شما را بدهد. مدیران سازمان تنها حسابهایی هستند که میتوانند برنامه را برای استفاده در دامنههای خود به لیست مجاز اضافه کنند.
در بخش سوالات متداول، نحوه نصب برنامه در کل دامنه را بیاموزید . برنامه من کاربرانی با حسابهای سازمانی از یک دامنه Google Workspace دیگر دارد .