Esta página de referencia describe la API de JavaScript de soporte de iframe intermedio, que le permite manipular el iframe intermedio en la UX posterior.
La siguiente tabla enumera todos los métodos disponibles y sus comportamientos.
| Métodos | |
|---|---|
verifyParentOrigin | realiza la verificación del origen principal |
notifyParentClose | notifica al marco principal que se omite el flujo de One Tap UX |
notifyParentDone | notifica al marco principal que el flujo de One Tap UX está terminado |
notifyParentResize | notifica al marco principal que cambie el tamaño del iframe intermedio |
notifyParentTapOutsideMode | notifica al marco principal si debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio |
Cargar la biblioteca JavaScript de compatibilidad con iframe intermedio
Coloque el siguiente fragmento de código en las páginas HTML donde desee cargar el iframe intermedio:
<script src="https://accounts.google.com/gsi/intermediatesupport"></script>
Método: google.accounts.id.intermediate.verifyParentOrigin
El método google.accounts.id.intermediate.verifyParentOrigin realiza la verificación del origen principal. Vea el siguiente ejemplo de código del método:
google.accounts.id.intermediate.verifyParentOrigin(
origins, verifiedCallback, verificationFailedCallback)
El siguiente ejemplo de código muestra cómo mostrar la IU solo después de verificar el origen principal:
<script>
window.onload = () => {
google.accounts.id.intermediate.verifyParentOrigin(
"https://example.com", showUI, showError);
};
</script>
La siguiente tabla enumera los parámetros:
| Parámetro | |
|---|---|
origins | Los orígenes que pueden incrustar el iframe intermedio. |
verifiedCallback | El método de devolución de llamada de JavaScript que se activará cuando el origen principal actual tenga permitido incrustar el iframe intermedio. |
verificationFailedCallback | El método de devolución de llamada de JavaScript que se activará cuando el origen principal actual no pueda incrustar el iframe intermedio. |
orígenes
Los orígenes que pueden incrustar el iframe intermedio. Consulte la siguiente tabla para obtener más información:
| Tipo | Requerido | Ejemplo |
|---|---|---|
| cadena, matriz de cadena o función | Opcional | allowed_parent_origin: "https://example.com" |
La siguiente tabla enumera los tipos de valores admitidos y sus descripciones.
| Tipos de valor | ||
|---|---|---|
string | Un URI de dominio único. | "https://example.com" |
string array | Una matriz de URI de dominio. | "https: //news.example.com,https: //local.example.com" |
VerifiedCallback
Este campo es un método de devolución de llamada de JavaScript que se activará cuando el origen principal actual pueda incrustar el iframe intermedio.
verificaciónFailedCallback
Este campo es un método de devolución de llamada de JavaScript que se activará cuando el origen principal actual no pueda incrustar el iframe intermedio.
Método: google.accounts.id.intermediate.notifyParentClose
El método google.accounts.id.intermediate.notifyParentClose notifica al marco principal que cierre el iframe intermedio cuando se omite el flujo de One Tap UX. Vea el siguiente ejemplo de código del método:
google.accounts.id.intermediate.notifyParentClose()
Método: google.accounts.id.intermediate.notifyParentDone
El método google.accounts.id.intermediate.notifyParentClose notifica al marco principal que cierre el iframe intermedio y actualice el estado de inicio de sesión. Vea el siguiente ejemplo de código del método:
google.accounts.id.intermediate.notifyParentDone()
Método: google.accounts.id.intermediate.notifyParentResize
El método google.accounts.id.intermediate.notifyParentResize notifica al marco principal que google.accounts.id.intermediate.notifyParentResize el tamaño del iframe intermedio. Vea el siguiente ejemplo de código del método:
google.accounts.id.intermediate.notifyParentResize(height)
altura
La nueva altura en píxeles. Este es un campo obligatorio. El valor debe ser un número no negativo.
Si el parámetro de altura es mayor que 0, el iframe intermedio se establecerá en la nueva altura. Si el parámetro de altura es 0, el iframe intermedio se vuelve invisible. Un iframe oculto no está cerrado. Puede mostrarse más tarde mediante otra llamada al método de cambio de tamaño.
Método: google.accounts.id.intermediate.notifyParentTapOutsideMode
El método google.accounts.id.intermediate.notifyParentTapOutsideMode notifica al marco principal si debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio. Vea el siguiente ejemplo de código del método:
google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)
cancelar
Este valor booleano obligatorio indica si se cancela el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio.