API de JavaScript de compatibilidad de Iframe intermedia

En esta página de referencia, se describe la API de JavaScript de compatibilidad de iframe intermedio, que te permite manipular el iframe intermedio en la UX posterior.

Consulta la guía Cómo integrar One Tap con un Iframe para obtener información sobre cómo usar iframes intermedios.

En la siguiente tabla, se enumeran todos los métodos disponibles y sus comportamientos.

Métodos
verifyParentOrigin	realiza la verificación de origen superior
notifyParentClose	notifica al marco superior que se omitió el flujo de UX de One Tap
notifyParentDone	notifica al marco superior que finalizó el flujo de UX de One Tap
notifyParentResize	notifica al marco superior para que cambie el tamaño del iframe intermedio
notifyParentTapOutsideMode	notifica al marco superior si se debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio

Carga la biblioteca de JavaScript intermedia de la compatibilidad con Iframe

Coloca el siguiente fragmento de código en cualquier página HTML en la que desees 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 superior. Consulta el siguiente ejemplo de código del método:

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

En el siguiente ejemplo de código, se muestra cómo mostrar la IU solo después de verificar el origen superior:

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

En la siguiente tabla, se enumeran los parámetros:

Parámetro
origins	Los orígenes que tienen permitido incorporar el iframe intermedio.
verifiedCallback	El método de devolución de llamada de JavaScript que se activa cuando el origen superior actual puede incorporar el iframe intermedio.
verificationFailedCallback	El método de devolución de llamada de JavaScript que se activa cuando el origen superior actual no puede incorporar el iframe intermedio.

orígenes

Los orígenes que tienen permitido incorporar el iframe intermedio. Consulta la siguiente tabla para obtener más información:

Tipo	Obligatorio	Ejemplo
string, función o arreglo de strings	Opcional	allowed_parent_origin: "https://example.com"

En la siguiente tabla, se enumeran los tipos de valores admitidos y sus descripciones.

Tipos de valor
string	Un URI de dominio único.	“https://example.com”.
string array	Un array de URI de dominio.	"https://noticias.example.com,https://local.example.com"

Nota: Una string con URI separados por comas no es válida. En su lugar, usa un objeto de arreglo de JavaScript.

verificadoDevolución de llamada

Este campo es un método de devolución de llamada de JavaScript que se activa cuando el origen superior actual puede incorporar el iframe intermedio.

verificationFailedCallback

Este campo es un método de devolución de llamada de JavaScript que se activa cuando el origen superior actual no puede incorporar el iframe intermedio.

Advertencia: Si la página de contenido no responde a la solicitud de verificación del dominio, el proceso de verificación espera por siempre. En este caso, no se invoca a verifiedCallback ni a verificationFailedCallback.

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

El método google.accounts.id.intermediate.notifyParentClose notifica al marco superior para que cierre el iframe intermedio cuando se omite el flujo de UX de One Tap. Consulta 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 superior para cerrar el iframe intermedio y actualizar el estado de acceso. Consulta 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 superior para que cambie el tamaño del iframe intermedio. Consulta el siguiente ejemplo de código del método:

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

Nota: No puedes cambiar el ancho del iframe intermedio.

alto

La nueva altura en píxeles. Éste 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 establece en la altura nueva. Si el parámetro de altura es 0, el iframe intermedio se vuelve invisible. Un iframe oculto no se cierra. Se puede mostrar más adelante con 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 superior si debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio. Consulta el siguiente ejemplo de código del método:

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

cancelar

Este valor booleano obligatorio indica si se debe cancelar el iframe intermedio cuando el usuario hace clic fuera de ese iframe.