مرجع سرویس گیرنده جاوا اسکریپت Google Sign-In

این مرجع روش‌ها و ویژگی‌های کلاینت جاوا اسکریپت را که برای پیاده‌سازی Google Sign-In در برنامه‌های کاربردی وب خود استفاده خواهید کرد، توضیح می‌دهد.

اگر در استفاده از کتابخانه با مشکلی مواجه شدید، آن را به مخزن GitHub ما گزارش دهید. .

Auth Setup

برای ایجاد شی gapi ، کتابخانه پلتفرم Google APIs را بارگیری کنید:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

پس از بارگیری کتابخانه پلتفرم، کتابخانه auth2 را بارگیری کنید:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init ( params )

شی GoogleAuth را راه اندازی می کند. قبل از فراخوانی متدهای gapi.auth2.GoogleAuth باید این روش را فراخوانی کنید.

هنگامی که شی GoogleAuth را مقداردهی اولیه می کنید، شی را با شناسه مشتری OAuth 2.0 خود و هر گزینه دیگری که می خواهید مشخص کنید پیکربندی می کنید. سپس، اگر کاربر قبلاً وارد سیستم شده باشد، شی GoogleAuth وضعیت ورود به سیستم کاربر را از جلسه قبل بازیابی می‌کند.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}

GoogleAuth.then ( onInit ، onError )

هنگامی که شی GoogleAuth به طور کامل مقداردهی اولیه شود، تابع onInit را فراخوانی می کند. اگر هنگام تنظیم اولیه خطایی ایجاد شود (این ممکن است در مرورگرهای قدیمی پشتیبانی نشده اتفاق بیفتد)، به جای آن تابع onError فراخوانی می شود.

کدهای خطا

idpiframe_initialization_failed

به‌عنوان مثال، به دلیل یک محیط پشتیبانی‌نشده، یک iframe مورد نیاز از Google راه‌اندازی نشد. ویژگی details اطلاعات بیشتری در مورد خطای مطرح شده ارائه می دهد.

gapi.auth2.ClientConfig

رابطی که پارامترهای پیکربندی مختلف را برای روش gapi.auth2.init نشان می دهد.

احراز هویت

GoogleAuth یک کلاس singleton است که روش هایی را ارائه می دهد که به کاربر اجازه می دهد با یک حساب Google وارد سیستم شود، وضعیت ورود به سیستم فعلی کاربر را دریافت کند، داده های خاصی را از نمایه Google کاربر دریافت کند، دامنه های اضافی درخواست کند و از حساب فعلی خارج شود.

gapi.auth2.getAuthInstance()

شی GoogleAuth را برمی‌گرداند. قبل از فراخوانی این متد باید شی GoogleAuth با gapi.auth2.init() مقداردهی اولیه کنید.

GoogleAuth.isSignedIn.get()

نشان می دهد که آیا کاربر فعلی وارد سیستم شده است یا خیر.

GoogleAuth.isSignedIn.listen(شنونده)

به تغییرات در وضعیت ورود به سیستم کاربر فعلی گوش دهید.

GoogleAuth.signIn()

کاربر را با گزینه های مشخص شده در gapi.auth2.init() وارد می کند.

کدهای خطا

به GoogleAuth.signIn(options) مراجعه کنید.

GoogleAuth.signIn ( options )

با استفاده از گزینه های مشخص شده کاربر را وارد می کند.

کدهای خطا

popup_closed_by_user

کاربر قبل از پایان ورود به سیستم، پنجره بازشو را بست.

access_denied

کاربر اجازه دسترسی به محدوده های مورد نیاز را رد کرد.

immediate_failed

هیچ کاربری نمی تواند به طور خودکار بدون درخواست جریان رضایت انتخاب شود. هنگام استفاده از signIn با گزینه prompt: 'none' خطایی ایجاد شد. استفاده از این گزینه نباید الزامی باشد، زیرا gapi.auth2.init اگر قبلاً در جلسه قبلی وارد سیستم شده باشد، به طور خودکار وارد سیستم می شود.

gapi.auth2.SignInOptions

رابطی که پارامترهای پیکربندی مختلف را برای روش GoogleAuth.signIn( options ) نشان می‌دهد.

GoogleAuth.signOut()

حساب جاری را از برنامه خارج می کند.

GoogleAuth.disconnect()

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

GoogleAuth.grantOfflineAccess ( options )

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

{
  scope: 'profile email'
}

auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

کدهای خطا

popup_closed_by_user

کاربر قبل از اتمام جریان رضایت، پنجره بازشو را بست.

access_denied

کاربر اجازه دسترسی به محدوده های مورد نیاز را رد کرد.

immediate_failed

هیچ کاربری نمی تواند به طور خودکار بدون درخواست جریان رضایت انتخاب شود. هنگام استفاده از signIn با گزینه prompt: 'none' خطایی ایجاد شد. استفاده از این گزینه نباید الزامی باشد، زیرا gapi.auth2.init اگر قبلاً در جلسه قبلی وارد سیستم شده باشد، به طور خودکار وارد سیستم می شود.

gapi.auth2.OfflineAccessOptions

رابطی که پارامترهای پیکربندی مختلف را برای روش GoogleAuth.grantOfflineAccess( options ) نشان می‌دهد.

GoogleAuth.attachClickHandler ( container ، options ، onsuccess ، onfailure )

جریان ورود به سیستم را به کنترل کننده کلیک ظرف مشخص شده متصل می کند.

کاربران

یک شی GoogleUser نشان دهنده یک حساب کاربری است. اشیاء GoogleUser معمولاً با فراخوانی ()GoogleAuth.currentUser.get به دست می‌آیند.

GoogleAuth.currentUser.get()

یک شی GoogleUser را برمی‌گرداند که نشان‌دهنده کاربر فعلی است. توجه داشته باشید که در یک نمونه GoogleAuth که به تازگی راه اندازی شده است، کاربر فعلی تنظیم نشده است. از متد currentUser.listen() یا GoogleAuth.then() برای دریافت نمونه اولیه GoogleAuth استفاده کنید.

GoogleAuth.currentUser.listen ( listener )

به تغییرات در currentUser گوش دهید.

GoogleUser.getId()

رشته شناسه منحصر به فرد کاربر را دریافت کنید.

GoogleUser.isSignedIn()

اگر کاربر وارد سیستم شده باشد، true را برمی‌گرداند.

GoogleUser.getHostedDomain()

اگر کاربر با حساب G Suite وارد شده باشد، دامنه G Suite کاربر را دریافت کنید.

GoogleUser.getGrantedScopes()

دامنه‌هایی را که کاربر به‌عنوان رشته‌ای با فاصله اختصاص داده است، دریافت کنید.

GoogleUser.getBasicProfile()

اطلاعات اولیه پروفایل کاربر را دریافت کنید.

GoogleUser.getAuthResponse (شاملAuthorizationData)

شی پاسخ را از جلسه تأیید کاربر دریافت کنید.

GoogleUser.reloadAuthResponse()

به روزرسانی نشانه دسترسی را مجبور می کند و سپس یک Promise برای AuthResponse جدید برمی گرداند.

gapi.auth2.AuthResponse

هنگام فراخوانی روش‌های GoogleUser.getAuthResponse( includeAuthorizationData ) یا GoogleUser.reloadAuthResponse() پاسخ داده می‌شود.

GoogleUser.hasGrantedScopes ( scopes )

در صورتی که کاربر محدوده های مشخص شده را اعطا کرده باشد، true برمی گرداند.

GoogleUser.grant ( options )

دامنه های اضافی را از کاربر درخواست کنید.

برای لیست پارامترها و کد خطا به GoogleAuth.signIn() مراجعه کنید.

GoogleUser.grantOfflineAccess ( options )

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

{
  scope: 'profile email'
}

GoogleUser.disconnect()

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

عناصر رابط کاربری

gapi.signin2.render( id ، options )

با استفاده از تنظیمات مشخص شده توسط شی options ، یک دکمه ورود به سیستم را در عنصر با شناسه داده شده ارائه می دهد.

{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}

پیشرفته

gapi.auth2.authorize ( params ، callback )

مجوز یک بار OAuth 2.0 را انجام می دهد. بسته به پارامترهای مورد استفاده، این یک پنجره بازشو به جریان ورود به سیستم Google باز می‌کند یا سعی می‌کند پاسخ درخواستی را بی‌صدا و بدون تعامل کاربر بارگیری کند.

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

• برنامه شما فقط یک بار باید یک نقطه پایانی Google API را درخواست کند، برای مثال برای بارگیری ویدیوهای YouTube مورد علاقه کاربر در اولین باری که وارد سیستم می‌شود.
• برنامه شما زیرساخت مدیریت جلسه خود را دارد و فقط یک بار به شناسه Token نیاز دارد تا کاربر در باطن شما را شناسایی کند.
• چندین شناسه مشتری در همان صفحه استفاده می شود.

{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}

مثال

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

کدهای خطا

idpiframe_initialization_failed

به‌عنوان مثال، به دلیل یک محیط پشتیبانی‌نشده، یک iframe مورد نیاز از Google راه‌اندازی نشد. ویژگی details اطلاعات بیشتری در مورد خطای مطرح شده ارائه می دهد.

popup_closed_by_user

کاربر قبل از پایان ورود به سیستم، پنجره بازشو را بست.

access_denied

کاربر اجازه دسترسی به محدوده های مورد نیاز را رد کرد.

immediate_failed

هیچ کاربری نمی تواند به طور خودکار بدون درخواست جریان رضایت انتخاب شود. هنگام استفاده از signIn با گزینه prompt: 'none' خطایی ایجاد شد.

gapi.auth2.AuthorizeConfig

رابطی که پارامترهای پیکربندی مختلف را برای متد gapi.auth2.authorize نشان می دهد.

gapi.auth2.AuthorizeResponse

پاسخ به فراخوانی متد gapi.auth2.authorize بازگشت.