Referencia de la API de JavaScript de compatibilidad con iframe intermedio

En esta página de referencia, se describe la API de JavaScript de compatibilidad con iframe intermedio, que usa One Tap para manipular el iframe intermedio en la UX posterior.

Consulta la guía Cómo integrar One Tap con un iframe para aprender a usar iframes intermedios.

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

Carga la biblioteca de JavaScript de compatibilidad con iframe intermedio

Coloca el siguiente fragmento de código en cualquier página HTML en la que quieras 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 que se verifique 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:

orígenes

Son los orígenes que pueden incorporar el iframe intermedio. Consulta la siguiente tabla para obtener más información:

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

verifiedCallback

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

verificationFailedCallback

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

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

El método google.accounts.id.intermediate.notifyParentClose notifica al marco superior 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.notifyParentDone notifica al marco superior que cierre el iframe intermedio y actualice 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 que cambie el tamaño del iframe intermedio. Consulta el siguiente ejemplo de código del método:

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

alto

Es 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 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 de 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 se debe cancelar el iframe intermedio cuando el usuario hace clic fuera de él. 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 él.