Google ile Oturum Açma JavaScript istemci referansı

Bu referans, web uygulamalarınızda Google ile oturum açma özelliğini uygulamak için kullanacağınız JavaScript istemci yöntemlerini ve özelliklerini açıklar.

Kitaplığı kullanırken herhangi bir sorunla karşılaşırsanız GitHub deposumuzda bildirin. .

Kimlik doğrulama kurulumu

gapi nesnesini oluşturmak için Google API'leri platform kitaplığını yükleyin:

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

Platform kitaplığı yüklendikten sonra auth2 kitaplığını yükleyin:

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

gapi.auth2.init(params)

GoogleAuth nesnesini başlatır. gapi.auth2.GoogleAuth'nın yöntemlerini çağırmadan önce bu yöntemi çağırmanız gerekir.

GoogleAuth nesnesini başlattığınızda nesneyi OAuth 2.0 istemci kimliğinizle ve belirtmek istediğiniz ek seçeneklerle yapılandırırsınız. Ardından, kullanıcı daha önce oturum açtıysa GoogleAuth nesnesi, kullanıcının önceki oturumdaki oturum açma durumunu geri yükler.

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

GoogleAuth.then(onInit, onError)

GoogleAuth nesnesi tamamen başlatıldığında onInit işlevini çağırır. Başlatma sırasında bir hata oluşursa (bu, desteklenmeyen eski tarayıcılarda olabilir) bunun yerine onError işlevi çağrılır.

Hata Kodları

idpiframe_initialization_failed

Örneğin, desteklenmeyen bir ortam nedeniyle Google'dan gerekli bir iFrame başlatılamadı. details mülkü, oluşturulan hata hakkında daha fazla bilgi verir.

gapi.auth2.ClientConfig

gapi.auth2.init yöntemi için farklı yapılandırma parametrelerini temsil eden arayüz.

Kimlik doğrulama

GoogleAuth, kullanıcının Google Hesabı ile oturum açmasına, kullanıcının mevcut oturum açma durumunu almasına, kullanıcının Google profilinden belirli verileri almasına, ek kapsamlar istemesine ve mevcut hesaptan çıkış yapmasına olanak tanıyan yöntemler sağlayan tekil bir sınıftır.

gapi.auth2.getAuthInstance()

GoogleAuth nesnesini döndürür. Bu yöntemi çağırmadan önce GoogleAuth nesnesini gapi.auth2.init() ile başlatmanız gerekir.

GoogleAuth.isSignedIn.get()

Geçerli kullanıcının oturum açıp açmadığını döndürür.

GoogleAuth.isSignedIn.listen(listener)

Geçerli kullanıcının oturum açma durumundaki değişiklikleri dinleyin.

GoogleAuth.signIn()

Kullanıcının oturumunu gapi.auth2.init() için belirtilen seçeneklerle açar.

Hata kodları

GoogleAuth.signIn(options) adresine göz atın.

GoogleAuth.signIn(options)

Belirtilen seçenekleri kullanarak kullanıcının oturumunu açar.

Hata kodları

popup_closed_by_user

Kullanıcı, oturum açma akışını tamamlamadan pop-up'ı kapattı.

access_denied

Kullanıcı, gerekli kapsamlar için izni reddetti.

immediate_failed

Rıza akışı istem olmadan hiçbir kullanıcı otomatik olarak seçilememiştir. prompt: 'none' seçeneğiyle signIn kullanılırken hata oluştu. gapi.auth2.init, önceki bir oturumda oturum açılmışsa kullanıcının oturumunu otomatik olarak açacağından bu seçeneğin kullanılması gerekmez.

gapi.auth2.SignInOptions

GoogleAuth.signIn(options) yöntemi için farklı yapılandırma parametrelerini temsil eden arayüz.

GoogleAuth.signOut()

Mevcut hesabın uygulamadaki oturumunu kapatır.

GoogleAuth.disconnect()

Kullanıcının verdiği tüm kapsamları iptal eder.

GoogleAuth.grantOfflineAccess(options)

Belirtilen kapsamlara çevrimdışı olarak erişmek için kullanıcıdan izin alın.

{
  scope: 'profile email'
}

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

Hata kodları

popup_closed_by_user

Kullanıcı, izin akışı tamamlanmadan pop-up'ı kapattı.

access_denied

Kullanıcı, gerekli kapsamlar için izni reddetti.

immediate_failed

Rıza akışı istem olmadan hiçbir kullanıcı otomatik olarak seçilememiştir. prompt: 'none' seçeneğiyle signIn kullanılırken hata oluştu. gapi.auth2.init, daha önce oturum açılmışsa kullanıcının oturumunu otomatik olarak açacağından bu seçeneğin kullanılması gerekmez.

gapi.auth2.OfflineAccessOptions

GoogleAuth.grantOfflineAccess(options) yöntemi için farklı yapılandırma parametrelerini temsil eden arayüz.

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

Oturum açma akışını, belirtilen kapsayıcının tıklama işleyicisine ekler.

Kullanıcılar

GoogleUser nesnesi bir kullanıcı hesabını temsil eder. GoogleUser nesneleri genellikle GoogleAuth.currentUser.get() çağrısı yapılarak elde edilir.

GoogleAuth.currentUser.get()

Geçerli kullanıcıyı temsil eden bir GoogleUser nesnesi döndürür. Yeni başlatılmış bir GoogleAuth örneğinde geçerli kullanıcının ayarlanmadığını unutmayın. İlkleştirilmiş bir GoogleAuth örneği almak için currentUser.listen() yöntemini veya GoogleAuth.then() yöntemini kullanın.

GoogleAuth.currentUser.listen(listener)

currentUser değişkenindeki değişiklikleri dinleme.

GoogleUser.getId()

Kullanıcının benzersiz kimlik dizesini alın.

GoogleUser.isSignedIn()

Kullanıcı oturum açtıysa true döndürür.

GoogleUser.getHostedDomain()

Kullanıcı G Suite hesabıyla oturum açtıysa kullanıcının G Suite alanını alın.

GoogleUser.getGrantedScopes()

Kullanıcının izin verdiği kapsamları boşlukla ayrılmış bir dize olarak alın.

GoogleUser.getBasicProfile()

Kullanıcının temel profil bilgilerini alma.

GoogleUser.getAuthResponse(includeAuthorizationData)

Kullanıcının kimlik doğrulama oturumundan yanıt nesnesini alın.

GoogleUser.reloadAuthResponse()

Erişim jetonunun yenilenmesini zorunlu kılar ve ardından yeni AuthResponse için bir Promise döndürür.

gapi.auth2.AuthResponse

GoogleUser.getAuthResponse(includeAuthorizationData) veya GoogleUser.reloadAuthResponse() yöntemleri çağırıldığında döndürülen yanıt.

GoogleUser.hasGrantedScopes(scopes)

Kullanıcı belirtilen kapsamları verdiyse doğru değerini döndürür.

GoogleUser.grant(options)

Kullanıcıdan ek kapsamlar isteyebilirsiniz.

Parametrelerin listesi ve hata kodu için GoogleAuth.signIn() bölümüne bakın.

GoogleUser.grantOfflineAccess(options)

Belirtilen kapsamlara çevrimdışı olarak erişmek için kullanıcıdan izin alın.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Kullanıcının uygulama için verdiği tüm kapsamları iptal eder.

Kullanıcı arayüzü öğeleri

gapi.signin2.render(id, options)

options nesnesi tarafından belirtilen ayarları kullanarak, belirtilen kimliğe sahip öğede bir oturum açma düğmesi oluşturur.

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

Gelişmiş

gapi.auth2.authorize(params, callback)

Tek seferlik bir OAuth 2.0 yetkilendirmesi gerçekleştirir. Kullanılan parametrelere bağlı olarak, Google oturum açma akışını içeren bir pop-up açılır veya istenen yanıt, kullanıcı etkileşimi olmadan sessizce yüklenmeye çalışılır.

Bu yöntemin yararlı olduğu bazı kullanım alanları:

• Uygulamanızın, Google API uç noktasını yalnızca bir kez istemesi gerekir (ör. kullanıcı ilk kez oturum açtığında favori YouTube videolarını yüklemek için).
• Uygulamanızın kendi oturum yönetimi altyapısı vardır ve arka uçta kullanıcıyı tanımlamak için kimlik jetonunun yalnızca bir kez kullanılması gerekir.
• Aynı sayfada birden fazla müşteri kimliği kullanılıyor.

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

Örnek

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.
});

Hata kodları

idpiframe_initialization_failed

Örneğin, desteklenmeyen bir ortam nedeniyle Google'dan gerekli bir iFrame başlatılamadı. details mülkü, oluşturulan hata hakkında daha fazla bilgi verir.

popup_closed_by_user

Kullanıcı, oturum açma akışını tamamlamadan pop-up'ı kapattı.

access_denied

Kullanıcı, gerekli kapsamlar için izni reddetti.

immediate_failed

Rıza akışı istem olmadan hiçbir kullanıcı otomatik olarak seçilememiştir. prompt: 'none' seçeneğiyle signIn kullanılırken hata oluştu.

gapi.auth2.AuthorizeConfig

gapi.auth2.authorize yöntemi için farklı yapılandırma parametrelerini temsil eden arayüz.

gapi.auth2.AuthorizeResponse

Yanıt, gapi.auth2.authorize yönteminin geri çağırma işlevine döndürülür.