Referencia de la API de JavaScript de compatibilidad con iframe intermedio

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

Consulta la guía Integrate One Tap using an 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 del origen principal.
notifyParentClose Notifica al iframe principal que se omitió el flujo de UX de One Tap.
notifyParentDone Notifica al iframe principal que finalizó el flujo de UX de One Tap.
notifyParentResize Notifica al iframe principal que cambie el tamaño del iframe intermedio.
notifyParentTapOutsideMode Notifica al iframe principal si se debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio

Carga la biblioteca de JavaScript de Intermediate Iframe Support

Coloca el siguiente fragmento de código en las páginas HTML en las 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 principal. 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 principal:

<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 Son los orígenes que pueden incorporar el iframe intermedio.
verifiedCallback Es el método de devolución de llamada de JavaScript que se activa cuando se permite que el origen principal actual inserte el iframe intermedio.
verificationFailedCallback Es el método de devolución de llamada de JavaScript que se activa cuando el origen principal actual no tiene permiso para incorporar el iframe intermedio.

orígenes

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

Tipo Obligatorio Ejemplo
cadena, array de cadenas o función Opcional allowed_parent_origin: "https://example.com"

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

Tipos de valores
string Es el URI de un solo dominio. "https://example.com"
string array Es un array de URIs 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 activa cuando se permite que el origen principal actual incorpore el iframe intermedio.

verificationFailedCallback

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

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

El método google.accounts.id.intermediate.notifyParentClose notifica al iframe principal que cierre el iframe intermedio cuando se omite el flujo de UX de Acceder con un toque. 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 iframe principal 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 iframe principal 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

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 nueva altura. Si el parámetro de altura es 0, el iframe intermedio se vuelve invisible. No se cierra un iframe oculto. 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 iframe principal 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.