Referência do cliente JavaScript do Login do Google

Esta referência descreve os métodos e atributos do cliente JavaScript que você usar para implementar o Login do Google nos seus aplicativos da Web.

Se você encontrar qualquer problema ao usar a biblioteca, informe nossa equipe Repositório do GitHub.

Configuração de autenticação

Carregue a biblioteca da plataforma de APIs do Google para criar o objeto gapi:

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

Depois que a biblioteca da plataforma for carregada, carregue a biblioteca auth2:

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

gapi.auth2.init(params)

Inicializa o objeto GoogleAuth. É necessário chamar esse método antes de chamar os métodos do gapi.auth2.GoogleAuth.

Ao inicializar o objeto GoogleAuth, você o configura com o ID do cliente OAuth 2.0 e outras opções que quiser especificar. Em seguida, se o usuário já tiver feito login, o objeto GoogleAuth vai restaurar o estado de login da sessão anterior.

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

GoogleAuth.then(onInit, onError)

Chama a função onInit quando o objeto GoogleAuth está totalmente inicializado. Se ocorrer um erro durante a inicialização (isso pode acontecer em navegadores antigos incompatíveis), a função onError será chamada.

Códigos de erro

idpiframe_initialization_failed

Falha ao inicializar um iframe obrigatório do Google, por exemplo, devido a um de nuvem. Uma propriedade details dará mais informações sobre o erro gerado.

gapi.auth2.ClientConfig

Interface que representa os diferentes parâmetros de configuração do método gapi.auth2.init.

Autenticação

GoogleAuth é uma classe singleton que oferece métodos para permitir que o usuário faça login com uma Conta do Google, confira o status de login atual, acesse dados específicos do perfil do Google, solicite escopos adicionais e saia da conta atual.

gapi.auth2.getAuthInstance()

Retorna o objeto GoogleAuth. Inicialize o objeto GoogleAuth com gapi.auth2.init() antes de chamar esse método.

GoogleAuth.isSignedIn.get()

Informa se o usuário atual está conectado.

GoogleAuth.isSignedIn.listen(listener)

Detectar mudanças no estado de login do usuário atual.

GoogleAuth.signIn()

Faz o login do usuário com as opções especificadas para gapi.auth2.init().

Códigos de erro

Consulte GoogleAuth.signIn(options).

GoogleAuth.signIn(options)

Faz o login do usuário usando as opções especificadas.

Códigos de erro

popup_closed_by_user

O usuário fechou o pop-up antes de concluir o fluxo de login.

access_denied

O usuário negou a permissão para os escopos necessários.

immediate_failed

Nenhum usuário pode ser selecionado automaticamente sem a solicitação do fluxo de consentimento. Erro gerado quando usando signIn com a opção prompt: 'none'. Essa opção não deve ser porque o gapi.auth2.init fará o login do usuário automaticamente se conectado anteriormente em uma sessão anterior.

gapi.auth2.SignInOptions

Interface que representa os diferentes parâmetros de configuração do GoogleAuth.signIn(options).

GoogleAuth.signOut()

Desconecta a conta atual do aplicativo.

GoogleAuth.disconnect()

Revoga todos os escopos concedidos pelo usuário.

GoogleAuth.grantOfflineAccess(options)

Conseguir permissão do usuário para acessar os escopos especificados off-line.

{
  scope: 'profile email'
}

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

Códigos de erro

popup_closed_by_user

O usuário fechou o pop-up antes de finalizar o fluxo de consentimento.

access_denied

O usuário negou a permissão para os escopos necessários.

immediate_failed

Nenhum usuário pode ser selecionado automaticamente sem a solicitação do fluxo de consentimento. Erro gerado quando usando signIn com a opção prompt: 'none'. Essa opção não deve ser porque o gapi.auth2.init fará o login do usuário automaticamente se conectado anteriormente em uma sessão anterior.

gapi.auth2.OfflineAccessOptions

Interface que representa os diferentes parâmetros de configuração do GoogleAuth.grantOfflineAccess(options) .

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

Anexa o fluxo de login ao gerenciador de cliques do contêiner especificado.

Usuários

Um objeto GoogleUser representa uma conta de usuário. Objetos GoogleUser normalmente são obtidos chamando GoogleAuth.currentUser.get().

GoogleAuth.currentUser.get()

Retorna um objeto GoogleUser. que representa o usuário atual. Em um ambiente recém-inicializado GoogleAuth, o usuário atual não foi definido. Use o Método currentUser.listen() ou o GoogleAuth.then() para receber uma instância do GoogleAuth inicializada.

GoogleAuth.currentUser.listen(listener)

Detectar mudanças em currentUser.

GoogleUser.getId()

Recebe a string de ID exclusivo do usuário.

GoogleUser.isSignedIn()

Retorna "true" se o usuário está conectado.

GoogleUser.getHostedDomain()

Verifique o domínio do G Suite do usuário se ele tiver feito login com uma conta do G Suite.

GoogleUser.getGrantedScopes()

Recebe os escopos concedidos pelo usuário como uma string delimitada por espaço.

GoogleUser.getBasicProfile()

Conseguir as informações básicas do perfil do usuário.

GoogleUser.getAuthResponse(includeAuthorizationData)

Receba o objeto de resposta da sessão de autenticação do usuário.

GoogleUser.reloadAuthResponse()

Força uma atualização do token de acesso e retorna uma promessa para o novo AuthResponse.

gapi.auth2.AuthResponse

A resposta retornada ao chamar GoogleUser.getAuthResponse(includeAuthorizationData) ou GoogleUser.reloadAuthResponse() métodos.

GoogleUser.hasGrantedScopes(scopes)

Retorna true se o usuário concedeu os escopos especificados.

GoogleUser.grant(options)

Solicitar escopos adicionais ao usuário.

Consulte GoogleAuth.signIn() para ver a lista de parâmetros e o código do erro.

GoogleUser.grantOfflineAccess(options)

Conseguir permissão do usuário para acessar os escopos especificados off-line.

{
  scope: 'profile email'
}

GoogleUser.disconnect()

Revoga todos os escopos concedidos pelo usuário ao aplicativo.

Elementos da interface

gapi.signin2.render(id, options)

Renderiza um botão de login no elemento com o ID fornecido, usando as configurações especificadas pelo objeto options.

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

Avançado

gapi.auth2.authorized(params, callback)

Executa uma autorização única do OAuth 2.0. Dependendo dos parâmetros usados, isso abrirá uma pop-up para o fluxo de login do Google ou tente carregar a resposta solicitada silenciosamente, sem interação do usuário.

Alguns casos de uso em que esse método é útil incluem:

• Seu aplicativo só precisa solicitar um endpoint de API do Google uma vez, por exemplo, para carregar aos vídeos favoritos do YouTube na primeira vez que ele fizer login.
• Seu aplicativo tem a própria infraestrutura de gerenciamento de sessão e exige apenas o Token de ID uma vez para identificar o usuário no back-end.
• Vários Client-IDs são usados na mesma página.

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

Exemplo

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

Códigos de erro

idpiframe_initialization_failed

Falha ao inicializar um iframe obrigatório do Google, por exemplo, devido a um de nuvem. Uma propriedade details dará mais informações sobre o erro gerado.

popup_closed_by_user

O usuário fechou o pop-up antes de concluir o fluxo de login.

access_denied

O usuário negou a permissão para os escopos necessários.

immediate_failed

Nenhum usuário pode ser selecionado automaticamente sem a solicitação do fluxo de consentimento. Erro gerado quando usando signIn com a opção prompt: 'none'.

gapi.auth2.AuthorizeConfig

Interface que representa os diferentes parâmetros de configuração do gapi.auth2.authorize.

gapi.auth2.AuthorizeResponse

A resposta retornada ao retorno de chamada do gapi.auth2.authorize.