Google ile Oturum Açma JavaScript istemci referansı

Bu referansta, web uygulamalarınıza Google ile Oturum Açma işlevini uygulamak için kullanacağınız JavaScript istemci yöntemleri ve özellikleri açıklanmaktadır.

Kitaplığı kullanırken herhangi bir sorunla karşılaşırsanız lütfen GitHub depomuza 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 yöntemini çağırmadan önce bu yöntemi çağırmalısınız.

GoogleAuth nesnesini başlattığınızda, nesneyi OAuth 2.0 istemci kimliğinizle ve belirtmek istediğiniz diğer seçeneklerle yapılandırırsınız. Ardından, kullanıcı zaten oturum açmışsa 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 gerçekleşebilir) yerine onError işlevi çağrılır.

Hata Kodları

idpiframe_initialization_failed

Örneğin, desteklenmeyen bir ortam nedeniyle gerekli bir iframe Google'dan başlatılamadı. details özelliği, verilen hatayla ilgili daha fazla bilgi sağlar.

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 bir Google hesabıyla oturum açmasına, kullanıcının mevcut oturum açma durumunu öğrenmesine, kullanıcının Google profilinden belirli verileri almasına, ek kapsam istemesine ve geçerli hesabın oturumunu kapatmasına olanak tanıyan yöntemler sağlayan bir tekil 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çmış olup olmadığı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()

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

Hata kodları

Şu sayfaya göz atın: GoogleAuth.signIn(options).

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ı, gereken kapsamlara yönelik izni reddetti.

immediate_failed

İzin akışı istenmeden hiçbir kullanıcı otomatik olarak seçilemedi. prompt: 'none' seçeneğiyle signIn kullanıldığında hata oluştu. gapi.auth2.init, daha önce bir önceki oturum sırasında oturum açmışsa kullanıcının oturumunu otomatik olarak açacağından bu seçeneğin kullanılması zorunlu değildir.

gapi.auth2.SignInOptions

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

GoogleAuth.signOut()

Uygulamadaki geçerli hesabın oturumunu kapatır.

GoogleAuth.disconnect()

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

GoogleAuth.grantÇevrimdışıAccess(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ışını tamamlamadan pop-up'ı kapattı.

access_denied

Kullanıcı, gereken kapsamlara yönelik izni reddetti.

immediate_failed

İzin akışı istenmeden hiçbir kullanıcı otomatik olarak seçilemedi. prompt: 'none' seçeneğiyle signIn kullanıldığında hata oluştu. gapi.auth2.init, daha önce bir önceki oturum sırasında oturum açmışsa kullanıcının oturumunu otomatik olarak açacağından bu seçeneğin kullanılması zorunlu değildir.

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ılan bir GoogleAuth örneğinde geçerli kullanıcının ayarlanmadığını unutmayın. Başlatılmış bir GoogleAuth örneği almak için currentUser.listen() yöntemini veya GoogleAuth.then() yöntemini kullanın.

GoogleAuth.currentUser.listen(listener)

currentUser'daki değişiklikleri dinleyin.

GoogleUser.getId()

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

GoogleUser.isSignedIn()

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

GoogleUser.getHostedDomain()

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

GoogleUser.getGrantedScopes()

Kullanıcının boşlukla sınırlandırılmış dize olarak verdiği kapsamları alın.

GoogleUser.getBasicProfile()

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

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 true değerini döndürür.

GoogleUser.grant(options)

Kullanıcıya ek kapsamlar isteyin.

Parametre listesi ve hata kodu için GoogleAuth.signIn() sayfasına bakın.

GoogleUser.grantÇevrimdışıAccess(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 öğede, belirtilen kimliğe sahip 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.authorized(params, callback)

Bir defalık OAuth 2.0 yetkilendirmesi gerçekleştirir. Kullanılan parametrelere bağlı olarak, Google ile oturum açma akışında bir pop-up açılır veya istenen yanıtı kullanıcı etkileşimi olmadan sessizce yüklemeye çalışır.

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

• Uygulamanızın yalnızca bir Google API uç noktası istemesi gerekir. Örneğin, kullanıcı ilk kez oturum açtığında favori YouTube videolarını yükleyebilir.
• Uygulamanız kendi oturum yönetimi altyapısına sahiptir ve arka ucunuzda kullanıcıyı tanımlamak için Kimlik Jetonu'nu yalnızca bir kez gerektirir.
• Aynı sayfada çeşitli İstemci Kimlikleri kullanılır.

{
  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 gerekli bir iframe Google'dan başlatılamadı. details özelliği, verilen hatayla ilgili daha fazla bilgi sağlar.

popup_closed_by_user

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

access_denied

Kullanıcı, gereken kapsamlara yönelik izni reddetti.

immediate_failed

İzin akışı istenmeden hiçbir kullanıcı otomatik olarak seçilemedi. prompt: 'none' seçeneğiyle signIn kullanıldığında 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ğırmasına döndürüldü.