Esta página de referência descreve a API JavaScript de suporte a iframe intermediário, usada pelo One Tap para manipular o iframe intermediário em UXs subsequentes.
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.
| Métodos | |
|---|---|
verifyParentOrigin |
realiza a verificação da origem principal |
notifyParentClose |
notifica o frame principal de que o fluxo da UX do One Tap foi ignorado |
notifyParentDone |
notifica o frame pai de que o fluxo de UX do One Tap foi concluído |
notifyParentResize |
notifica o frame principal para redimensionar o iframe intermediário |
notifyParentTapOutsideMode |
notifica o frame pai se o iframe intermediário deve ser cancelado quando o usuário clica fora dele. |
Carregar a biblioteca JavaScript de suporte a iframe intermediário
Coloque o snippet de código a seguir em qualquer página HTML em que você queira 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 da origem principal. Confira o exemplo de código do método:
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 principal é verificada:
<script>
window.onload = () => {
google.accounts.id.intermediate.verifyParentOrigin(
"https://example.com", showUI, showError);
};
</script>
A tabela a seguir lista os parâmetros:
| Parâmetro | |
|---|---|
origins |
As origens que podem incorporar o iframe intermediário. |
verifiedCallback |
O método de callback do JavaScript acionado quando a origem pai atual pode incorporar o iframe intermediário. |
verificationFailedCallback |
O método de callback do JavaScript acionado quando a origem pai atual não pode incorporar o iframe intermediário. |
origens
As origens que podem incorporar o iframe intermediário. Consulte a tabela a seguir para mais informações:
| Tipo | Obrigatório | Exemplo |
|---|---|---|
| string, matriz de strings ou função | Opcional | allowed_parent_origin: "https://example.com" |
A tabela a seguir lista os tipos de valores compatíveis e as descrições deles.
| Tipos de valores | ||
|---|---|---|
string |
Um URI de domínio único. | "https://example.com" |
string array |
Uma matriz de URIs de domínio. | "https://news.example.com,https://local.example.com" |
verifiedCallback
Esse campo é um método de callback JavaScript acionado quando a origem principal atual tem permissão para incorporar o iframe intermediário.
verificationFailedCallback
Esse campo é um método de retorno de chamada do JavaScript acionado quando a origem pai atual não pode 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 da UX do toque único é
ignorado. Confira o exemplo de código do método:
google.accounts.id.intermediate.notifyParentClose()
Método: google.accounts.id.intermediate.notifyParentDone
O método google.accounts.id.intermediate.notifyParentClose notifica o
frame pai para fechar o iframe intermediário e atualizar o status de login. Confira
o exemplo de código a seguir do método:
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
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 como a nova altura. Se o parâmetro de altura for 0, o iframe intermediário 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:
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 clicar fora dele.