API intermedia de compatibilidad con Iframe para JavaScript

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

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 omite el flujo de UX de One Tap
notifyParentDone Notifica al marco superior que se completó el flujo de UX de One Tap
notifyParentResize notifica al marco superior para cambiar el tamaño del iframe intermedio
notifyParentTapOutsideMode notifica al marco superior si debe cancelar el iframe intermedio cuando el usuario hace clic fuera del iframe intermedio

Carga la biblioteca JavaScript de compatibilidad intermedia de 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 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 verifica 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 pueden incorporar el iframe intermedio.
verifiedCallback El método de devolución de llamada de JavaScript que se activará cuando se permita la incorporación del origen superior actual en el iframe intermedio.
verificationFailedCallback El método de devolución de llamada de JavaScript que se activará cuando no se permita la incorporación del origen superior actual en el iframe intermedio.

orígenes

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

Tipo Obligatorio Ejemplo
string, arreglo de strings 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 valor
string Un solo URI de dominio. &https://example.com"
string array Una matriz de URI de dominio. &https://news.example.com,https://local.ejemplo.com"

devolución de llamada verificada

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

verificaciónFallaDeVerificación

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

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 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 para cambiar el tamaño del iframe intermedio. Consulta el siguiente ejemplo de código del método:

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

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 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. Se puede mostrar más tarde con otra llamada de método de cambio de tamaño.

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

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 del iframe intermedio.