Google ile Oturum Açma JavaScript istemcisi referansı

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

Kitaplığı kullanırken herhangi bir sorunla karşılaşırsanız lütfen GitHub depomuza bildirin.

Auth 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öntemlerini çağırmadan önce bu yöntemi çağırmanız gerekir.

GoogleAuth nesnesini ilk kullanıma hazırladığınızda nesneyi OAuth 2.0 istemci kimliği ve belirtmek istediğiniz ek seçeneklerle yapılandırırsınız. Ardından, kullanıcı zaten oturum açmışsa GoogleAuth nesnesi, kullanıcının bir ö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. İlk kullanıma hazırlama sırasında bir hata oluşursa (bu, desteklenmeyen eski tarayıcılarda yaşanabilir) bunun 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, oluşan hata ile ilgili daha fazla bilgi sağlar.

gapi.auth2.İstemciYapılandırması

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 geçerli oturum açma durumuna erişmesine, kullanıcının Google profilinden belirli verileri almasına, ek kapsam istemesine ve mevcut hesaptan oturumunu kapatmasına olanak tanıyan 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.isİmzalı.get()

Geçerli kullanıcının oturum açmış olup olmadığını döndürür.

GoogleAuth.isSignIn.listen(listeleyici)

Mevcut kullanıcının oturum açma durumundaki değişiklikleri dinleme.

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ı, gerekli kapsamlar için izni reddetti.

immediate_failed

Hiçbir kullanıcı, izin akışını istemeden otomatik olarak seçilemez. signIn, prompt: 'none' seçeneğiyle birlikte kullanıldığında hata oluştu. gapi.auth2.init daha önce bir oturum sırasında oturum açmışsa otomatik olarak oturum açacağı için bu seçeneğin kullanılması zorunlu değildir.

gapi.auth2.SignInOptions

GoogleAuth.signIn(options) yönteminin farklı yapılandırma parametrelerini temsil eden arayüz.

GoogleAuth.signOut()

Uygulamada geçerli hesabın 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ışını tamamlamadan pop-up'ı kapattı.

access_denied

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

immediate_failed

Hiçbir kullanıcı, izin akışını istemeden otomatik olarak seçilemez. signIn, prompt: 'none' seçeneğiyle birlikte kullanıldığında hata oluştu. gapi.auth2.init daha önce bir oturum sırasında oturum açmışsa otomatik olarak oturum açacağı için bu seçeneğin kullanılması zorunlu değildir.

gapi.auth2.Çevrimdışı ErişimSeçenekleri

GoogleAuth.grantOfflineAccess(options) yönteminin 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ı sayısı

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

GoogleAuth.currentUser.get()

Mevcut kullanıcıyı temsil eden GoogleUser nesnesini döndürür. Yeni başlatılan GoogleAuth örneğinde, geçerli kullanıcının ayarlanmadığını unutmayın. İlk kullanıma hazır GoogleAuth örneği almak için currentUser.listen() yöntemini veya GoogleAuth.then()'yı kullanın.

GoogleAuth.currentUser.listen(listener)

GeçerliKullanıcıdaki değişiklikleri dinleyin.

GoogleUser.getId()

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

GoogleUser.isSignIn()

Kullanıcı oturum açmışsa 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ı edinin.

GoogleKullanıcı.getGrantedScopes()

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

GoogleUser.getbasicProfile()

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

GoogleUser.getAuthResponse(includeYetkilendirmeVerisi)

Kullanıcının yetkilendirme oturumundan yanıt nesnesini al.

GoogleUser.reloadAuthResponse()

Erişim jetonunun yenilenmesini sağlar ve ardından yeni AuthResponse için bir Taahhüt döndürür.

gapi.auth2.AuthYanıt

GoogleUser.getAuthResponse(includeAuthorizationData) veya GoogleUser.reloadAuthResponse() yöntemleri aranırken yanıt döndürüldü.

GoogleUser.hasGrantedScopes(scopes)

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

GoogleKullanıcı.grant(options)

Kullanıcı için ek kapsamlar isteyin.

Parametre listesi ve hata kodu için GoogleAuth.signIn() adresine 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 kimlikteki öğ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.yetkilendirme(params, callback)

Bir kerelik 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ı sessizce, kullanıcı etkileşimi olmadan yüklemeye çalışır.

Bu yöntemin kullanışlı olduğu bazı durumlar şunlardır:

• Uygulamanızın, Google API uç noktasını yalnızca bir kez istemesi gerekir. Örneğin, kullanıcının favori YouTube videolarını ilk kez oturum açtığında yükleyebilirsiniz.
• Uygulamanızın kendi oturum yönetimi altyapısı vardır ve arka uçtaki kullanıcıyı tanımlamak için yalnızca bir kez kimlik jetonu gerekir.
• Aynı sayfada birkaç istemci 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 gerekli bir iframe Google'dan başlatılamadı. details özelliği, oluşan hata ile 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ı, gerekli kapsamlar için izni reddetti.

immediate_failed

Hiçbir kullanıcı, izin akışını istemeden otomatik olarak seçilemez. signIn, prompt: 'none' seçeneğiyle birlikte kullanıldığında hata oluştu.

gapi.auth2.Yetkilendir

gapi.auth2.authorize yönteminin farklı yapılandırma parametrelerini temsil eden arayüz.

gapi.auth2.Yetkilendir

Yanıt, gapi.auth2.authorize yönteminin geri çağırmasına döndürüldü.