Referência da API JavaScript de suporte a iframe intermediário

Esta página de referência descreve a API JavaScript de suporte ao iframe intermediário, usada pelo One Tap para manipular o iframe intermediário na UX subsequente.

Consulte o guia Integrar o One Tap usando um iframe para saber como usar iframes intermediários.

A tabela a seguir lista todos os métodos disponíveis e os comportamentos deles.

Carregar a biblioteca JavaScript de suporte a iframe intermediário

Insira o snippet de código a seguir em todas as páginas HTML em que você quer carregar o iframe intermediário:

<script src="https://accounts.google.com/gsi/intermediatesupport"></script>

Método: google.accounts.id.intermediate.verifyParentOrigin

O método google.accounts.id.intermediate.verifyParentOrigin realiza a verificação de origem pai. Confira o exemplo de código do método abaixo:

google.accounts.id.intermediate.verifyParentOrigin(
    origins, verifiedCallback, verificationFailedCallback)

O exemplo de código a seguir mostra como exibir a interface somente depois que a origem pai é verificada:

<script>
  window.onload = () => {
    google.accounts.id.intermediate.verifyParentOrigin(
        "https://example.com", showUI, showError);
  };
</script>

A tabela a seguir lista os parâmetros:

origens

As origens que podem incorporar o iframe intermediário. Consulte a tabela a seguir para mais informações:

A tabela a seguir lista os tipos de valor compatíveis e as descrições deles.

verifiedCallback

Esse campo é um método de callback JavaScript acionado quando a origem pai atual tem permissão para incorporar o iframe intermediário.

verificationFailedCallback

Esse campo é um método de callback do JavaScript acionado quando a origem pai atual não tem permissão para incorporar o iframe intermediário.

Método: google.accounts.id.intermediate.notifyParentClose

O método google.accounts.id.intermediate.notifyParentClose notifica o frame pai para fechar o iframe intermediário quando o fluxo de UX do One Tap é ignorado. Confira o exemplo de código do método abaixo:

google.accounts.id.intermediate.notifyParentClose()

Método: google.accounts.id.intermediate.notifyParentDone

O método google.accounts.id.intermediate.notifyParentDone notifica o frame pai para fechar o iframe intermediário e atualizar o status de login. Confira o exemplo de código do método a seguir:

google.accounts.id.intermediate.notifyParentDone()

Método: google.accounts.id.intermediate.notifyParentResize

O método google.accounts.id.intermediate.notifyParentResize notifica o frame pai para redimensionar o iframe intermediário. Confira o exemplo de código abaixo do método:

google.accounts.id.intermediate.notifyParentResize(height)

altura

A nova altura em pixels. Este campo é obrigatório. O valor precisa ser um número não negativo.

Se o parâmetro de altura for maior que 0, o iframe intermediário será definido com a nova altura. Se o parâmetro de altura for 0, o iframe intermediário vai ficar invisível. Um iframe oculto não foi fechado. Ele pode ser mostrado mais tarde por outra chamada de método de redimensionamento.

Método: google.accounts.id.intermediate.notifyParentTapOutsideMode

O método google.accounts.id.intermediate.notifyParentTapOutsideMode notifica o frame pai se o iframe intermediário deve ser cancelado quando o usuário clica fora dele. Confira o exemplo de código do método abaixo:

google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)

cancelar

Esse valor booleano obrigatório indica se o iframe intermediário deve ser cancelado quando o usuário clica fora dele.