Iniciar sesión con la referencia de la API de JavaScript de Google

Esta página de referencia describe la API de JavaScript de inicio de sesión. Puede utilizar esta API para mostrar el mensaje One Tap o el botón Iniciar sesión con Google en sus páginas web.

Método: google.accounts.id.initialize

El google.accounts.id.initialize método inicializa la sesión cliente con Google basada en el objeto de configuración. Vea el siguiente ejemplo de código del método:

google.accounts.id.initialize(IdConfiguration)

El siguiente código de ejemplo implementa la google.accounts.id.initialize método con un onload función:

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

Tipo de datos: IdConfiguration

La siguiente tabla muestra los campos y las descripciones de los IdConfiguration tipo de datos:

Campo
client_id	ID de cliente de su aplicación
auto_select	Habilita la selección automática.
callback	La función de JavaScript que maneja los tokens de ID. Google Un grifo y el botón Iniciar sesión con Google popup modo UX utilizan este atributo.
login_uri	La URL de su punto final de inicio de sesión. El botón Iniciar sesión con Google redirect modo UX utiliza este atributo.
native_callback	La función de JavaScript que maneja las credenciales de contraseña.
cancel_on_tap_outside	Cancela el mensaje si el usuario hace clic fuera del mensaje.
prompt_parent_id	El DOM ID del elemento contenedor de avisos de One Tap
nonce	Una cadena aleatoria para tokens de identificación
context	El título y las palabras en el mensaje de One Tap
state_cookie_domain	Si necesita llamar a One Tap en el dominio principal y sus subdominios, pase el dominio principal a este campo para que se utilice una única cookie compartida.
ux_mode	El flujo de UX del botón Iniciar sesión con Google
allowed_parent_origin	Los orígenes que pueden incrustar el iframe intermedio. One Tap se ejecutará en el modo iframe intermedio si se presenta este campo.
intermediate_iframe_close_callback	Anula el comportamiento de iframe intermedio predeterminado cuando los usuarios cierran manualmente One Tap.

Identificación del cliente

Este campo es el ID de cliente de su aplicación, que se encuentra y se crea en Google Developers Console. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	sí	client_id: "CLIENT_ID.apps.googleusercontent.com"

Selección automática

Este campo determina si un token de ID se devuelve automáticamente sin ninguna interacción del usuario cuando solo hay una sesión de Google que ha aprobado su aplicación anteriormente. El valor por defecto es false . Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
booleano	Opcional	auto_select: true

llamar de vuelta

Este campo es la función de JavaScript que maneja el token de ID devuelto por el mensaje One Tap o la ventana emergente. Este atributo es necesario si Google Un Toque o el botón Iniciar sesión con Google popup se utiliza el modo UX. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
función	Requerido para un grifo y el popup modo UX	callback: handleResponse

login_uri

Este atributo es el URI de su punto final de inicio de sesión. Puede omitirse si la página actual es su página de inicio de sesión, en cuyo caso la credencial se publica en esta página de forma predeterminada.

La respuesta de la credencial del token de ID se publica en su punto final de inicio de sesión cuando un usuario hace clic en el botón Iniciar sesión con Google y se utiliza el modo de redireccionamiento UX.

Consulte la siguiente tabla para obtener más información:

Escribe	Opcional	Ejemplo
URL	Por defecto, el URI de la página actual o el valor que especifique. Sólo se utiliza cuando ux_mode: "redirect" está ajustado.	login_uri="https://www.example.com/login"

Su punto final de inicio de sesión debe manejar peticiones POST que contienen una credential clave con un valor del testigo de identificación en el cuerpo.

La siguiente es una solicitud de ejemplo a su punto final de inicio de sesión:

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

Nota: Con la API de JavaScript, la respuesta de Google Un grifo y el botón Iniciar sesión con Google popup modo UX sólo pueden ser devueltos a la callback función de JavaScript. Probar el API HTML si la respuesta debe ser presentada de forma automática a login_uri .

native_callback

Este campo es el nombre de la función de JavaScript que maneja la credencial de contraseña devuelta por el administrador de credenciales nativo del navegador. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
función	Opcional	native_callback: handleResponse

cancel_on_tap_outside

Este campo establece si se cancela o no la solicitud de One Tap si un usuario hace clic fuera del mensaje. El valor por defecto es true . Se puede desactivar si se establece el valor a false . Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
booleano	Opcional	cancel_on_tap_outside: false

prompt_parent_id

Este atributo establece el ID DOM del elemento contenedor. Si no está configurado, el mensaje de One Tap se muestra en la esquina superior derecha de la ventana. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	prompt_parent_id: 'parent_id'

mientras tanto

Este campo es una cadena aleatoria utilizada por el token de ID para evitar ataques de repetición. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	nonce: "biaqbm70g23"

La longitud de Nonce está limitada al tamaño máximo de JWT admitido por su entorno y las restricciones de tamaño HTTP del servidor y del navegador individual.

contexto

Este campo cambia el texto del título y los mensajes en el mensaje de One Tap. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	context: "use"

La siguiente tabla enumera los contextos disponibles y sus descripciones:

Contexto
signin	"Inicia sesión con Google"
signup	"Regístrese con Google"
use	"Usar con Google"

state_cookie_domain

Si necesita mostrar One Tap en el dominio principal y sus subdominios, pase el dominio principal a este campo para que se utilice una única cookie de estado compartido. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	state_cookie_domain: "example.com"

ux_mode

Utilice este campo para configurar el flujo de UX utilizado por el botón Iniciar sesión con Google. El valor por defecto es popup . Este atributo no tiene ningún impacto en OneTap UX. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	ux_mode: "redirect"

La siguiente tabla enumera los modos UX disponibles y sus descripciones.

Modo UX
popup	Realiza el flujo de UX de inicio de sesión en una ventana emergente.
redirect	Realiza el flujo de UX de inicio de sesión mediante una redirección de página completa.

allow_parent_origin

Los orígenes que pueden incrustar el iframe intermedio. One Tap se ejecutará en el modo iframe intermedio si se presenta este campo. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cadena o matriz de cadenas	Opcional	allowed_parent_origin: "https://example.com"

La siguiente tabla enumera los tipos de valores admitidos y sus descripciones.

Tipos de valor
string	Un único URI de dominio.	"https://example.com"
string array	Una matriz de URI de dominio.	["https://news.example.com", "https://local.example.com"]

También se admiten prefijos comodín. Por ejemplo, "https://*.example.com" coincidirá example.com y sus subdominios en todos los niveles (por ejemplo news.example.com , login.news.example.com ). Cosas a tener en cuenta al usar comodines:

• Las cadenas de patrones no pueden estar compuestas únicamente por un comodín y un dominio de nivel superior. Por ejemplo https://*.com y https://*.co.uk no son válidos; Como se señaló anteriormente, "https://*.example.com" coincidirá con example.com y sus subdominios. También puede utilizar una matriz para representar 2 dominios diferentes. Por ejemplo, ["https://example1.com", "https://*.example2.com"] coincidirá con los dominios example1.com , example2.com y subdominios de example2.com
• Los dominios comodín deben comenzar con un esquema https: // seguro. "*.example.com" será considerado válido.

Nota: A diferencia de la API HTML, una cadena con URIs separados por comas no es válido para el allowed_parent_origin campo. En su lugar, utilice un objeto Array de JavaScript.

Si el valor de allowed_parent_origin campo no es válido, la inicialización de un grifo del modo de marco flotante intermedia fallaría y parada.

intermedio_iframe_close_callback

Anula el comportamiento de iframe intermedio predeterminado cuando los usuarios cierran manualmente One Tap tocando el botón 'X' en la interfaz de usuario de One Tap. El comportamiento predeterminado es eliminar el iframe intermedio del DOM inmediatamente.

El intermediate_iframe_close_callback campo sólo tiene efecto en el modo iframe intermedio. Y tiene impacto solo en el iframe intermedio, en lugar del iframe de One Tap. La IU de One Tap se elimina antes de que se invoque la devolución de llamada.

Escribe	Requerido	Ejemplo
función	Opcional	intermediate_iframe_close_callback: logBeforeClose

Método: google.accounts.id.prompt

Los google.accounts.id.prompt método presenta el indicador de un grifo o en el navegador nativo de administrador de credenciales después de la initialize() se invoca el método. Vea el siguiente ejemplo de código del método:

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

Normalmente, el prompt() método se llama al cargar la página. Debido al estado de la sesión y la configuración del usuario en el lado de Google, es posible que no se muestre la interfaz de usuario del mensaje One Tap. Para recibir notificaciones sobre el estado de la interfaz de usuario en diferentes momentos, pase una función para recibir notificaciones de estado de la interfaz de usuario.

Las notificaciones se activan en los siguientes momentos:

• Pantalla momento: se produce después de que el prompt() se llama al método. La notificación contiene un valor booleano para indicar si la interfaz de usuario se muestra o no.

• Momento se ha parado: se produce cuando el indicador de un grifo está cerrado por un auto cancelar, un manual de cancelar, o cuando Google no emite una credencial, por ejemplo, cuando la sesión seleccionada ha cerrado la sesión de Google.

  En estos casos, le recomendamos que continúe con los siguientes proveedores de identidad, si los hay.

• Momento descartado: se produce cuando Google recupera con éxito una credencial o un usuario desea interrumpir el flujo de recuperación de credenciales. Por ejemplo, cuando el usuario comienza a introducir su nombre de usuario y contraseña en el diálogo de registro, puede llamar a la google.accounts.id.cancel() método para cerrar el grifo Una pronta y desencadenar un momento descartado.

  Advertencia: Cuando en un momento descartado, no trate de cualquiera de los siguientes proveedores de identidad.

El siguiente ejemplo de código implementa el momento omitido:

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

Nota: No se le notifique de la pantalla, salta, o despedido momentos de la interfaz de usuario de administrador de credenciales nativa. No tenemos control sobre eso.

Tipo de datos: PromptMomentNotification

Los siguientes métodos de tabla muestra y descripciones de la PromptMomentNotification tipo de datos:

Método
isDisplayMoment()	¿Esta notificación es para un momento de visualización?
isDisplayed()	¿Es esta notificación para un momento de visualización y se muestra la interfaz de usuario?
isNotDisplayed()	¿Es esta notificación para un momento de visualización y no se muestra la interfaz de usuario?
getNotDisplayedReason()	La razón detallada por la que no se muestra la interfaz de usuario. Los siguientes son valores posibles: browser_not_supported invalid_client missing_client_id opt_out_or_no_session secure_http_required suppressed_by_user unregistered_origin unknown_reason
isSkippedMoment()	¿Esta notificación es por un momento omitido?
getSkippedReason()	La razón detallada del momento omitido. Los siguientes son valores posibles: auto_cancel user_cancel tap_outside issuing_failed
isDismissedMoment()	¿Esta notificación es para un momento descartado?
getDismissedReason()	El motivo detallado del despido. Los siguientes son valores posibles: credential_returned cancel_called flow_restarted
getMomentType()	Devuelve una cadena para el tipo de momento. Los siguientes son valores posibles: display skipped dismissed

Tipo de datos: CredentialResponse

Cuando su callback se invoca la función, un CredentialResponse objeto se pasa como parámetro. La siguiente tabla enumera los campos que están contenidos en el objeto de respuesta de la credencial:

Campo
credential	Este campo es el token de ID devuelto.
select_by	Este campo establece cómo se selecciona la credencial.

credencial

Este campo es el token de ID como una cadena JSON Web Token (JWT) codificada en base64.

Cuando decodificado , el JWT tiene el siguiente ejemplo:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "[e-mail]", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

El sub campo contiene un identificador único global de la cuenta de Google.

Usando el email , email_verified y hd campos que puede determinar si los ejércitos de Google y está autorizada para obtener una dirección de correo electrónico. En los casos en que Google tiene autoridad, se sabe que el usuario es el propietario legítimo de la cuenta.

Casos en los que Google tiene autoridad:

• email tiene un @gmail.com sufijo, se trata de una cuenta de Gmail.
• email_verified es verdadera y hd se establece, se trata de una cuenta de mayor Suite.

Los usuarios pueden registrarse para obtener cuentas de Google sin usar Gmail o G Suite. Cuando email no contiene un @gmail.com sufijo y hd está ausente Google no está autorizada y se recomienda la contraseña u otros métodos reto para verificar el usuario. email_verfied también puede ser cierto que Google inicialmente verifica que el usuario que se creó la cuenta de Google, sin embargo, la propiedad de la tercera cuenta de correo electrónico de las partes puede haber cambiado desde entonces.

select_by

La siguiente tabla muestra los posibles valores para el select_by campo. El tipo de botón utilizado junto con la sesión y el estado de consentimiento se utilizan para establecer el valor,

• El usuario presionó el botón One Tap o Sign In With Google o utilizó el proceso de inicio de sesión automático sin contacto.

• Se encontró una sesión existente o el usuario seleccionó e inició sesión en una cuenta de Google para establecer una nueva sesión.

• Antes de compartir las credenciales del token de ID con su aplicación, el usuario

  • presionó el botón Confirmar para otorgar su consentimiento para compartir credenciales, o
  • había otorgado previamente su consentimiento y había utilizado Seleccionar una cuenta para elegir una cuenta de Google.

El valor de este campo se establece en uno de estos tipos,

Valor	Descripción
auto	Inicio de sesión automático de un usuario con una sesión existente que previamente había otorgado su consentimiento para compartir credenciales.
user	Un usuario con una sesión existente que había otorgado previamente su consentimiento presionó el botón 'Continuar como' de One Tap para compartir las credenciales.
user_1tap	Un usuario con una sesión existente presionó el botón 'Continuar como' de One Tap para otorgar consentimiento y compartir credenciales. Se aplica solo a Chrome v75 y superior.
user_2tap	Un usuario sin una sesión existente presionó el botón 'Continuar como' de One Tap para seleccionar una cuenta y luego presionó el botón Confirmar en una ventana emergente para otorgar consentimiento y compartir credenciales. Se aplica a navegadores no basados ​​en Chromium.
btn	Un usuario con una sesión existente que previamente otorgó su consentimiento presionó el botón Iniciar sesión con Google y seleccionó una cuenta de Google en 'Elegir una cuenta' para compartir las credenciales.
btn_confirm	Un usuario con una sesión existente presionó el botón Iniciar sesión con Google y presionó el botón Confirmar para otorgar consentimiento y compartir credenciales.
btn_add_session	Un usuario sin una sesión existente que previamente otorgó su consentimiento presionó el botón Iniciar sesión con Google para seleccionar una cuenta de Google y compartir las credenciales.
btn_confirm_add_session	Un usuario sin una sesión existente primero presionó el botón Iniciar sesión con Google para seleccionar una cuenta de Google y luego presionó el botón Confirmar para dar su consentimiento y compartir las credenciales.

Método: google.accounts.id.renderButton

El google.accounts.id.renderButton método rinde un botón Iniciar sesión con Google en sus páginas web.

Vea el siguiente ejemplo de código del método:

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

Tipo de datos: GsiButtonConfiguration

La siguiente tabla muestra los campos y las descripciones de los GsiButtonConfiguration tipo de datos:

Atributo
type	El tipo de botón: icono o botón estándar.
theme	El tema del botón. Por ejemplo, lleno_azul o lleno_negro.
size	El tamaño del botón. Por ejemplo, pequeño o grande.
text	El texto del botón. Por ejemplo, "Iniciar sesión con Google" o "Registrarse con Google".
shape	La forma del botón. Por ejemplo, rectangular o circular.
logo_alignment	La alineación del logotipo de Google: izquierda o centro.
width	El ancho del botón, en píxeles.
locale	Si se establece, se representa el idioma del botón.

Tipos de atributos

Las siguientes secciones contienen detalles sobre el tipo de cada atributo y un ejemplo.

escribe

El tipo de botón. El valor por defecto es standard .

Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	sí	type: "icon"

La siguiente tabla enumera los tipos de botones disponibles y sus descripciones:

Escribe
standard	Un botón con texto o información personalizada:
icon	Un botón de icono sin texto:

tema

El tema del botón. El valor por defecto es outline . Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	theme: "filled_blue"

La siguiente tabla enumera los temas disponibles y sus descripciones:

Tema
outline	Un tema de botón estándar:
filled_blue	Un tema de botón relleno de azul:
filled_black	Un tema de botón relleno de negro:

Talla

El tamaño del botón. El valor por defecto es large . Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	size: "small"

La siguiente tabla enumera los tamaños de botón disponibles y sus descripciones:

Tamaño
large	Un botón grande:
medium	Un botón de tamaño mediano:
small	Un pequeño botón:

texto

El texto del botón. El valor por defecto es signin_with . No hay diferencias visuales para el texto de iconos que tienen diferentes text atributos. La única excepción es cuando el texto se lee para acceder a la pantalla.

Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	text: "signup_with"

La siguiente tabla enumera los textos de los botones disponibles y sus descripciones:

Texto
signin_with	El texto del botón es "Iniciar sesión con Google":
signup_with	El texto del botón es "Registrarse con Google":
continue_with	El texto del botón es "Continuar con Google":
signup_with	El texto del botón es "Iniciar sesión":

forma

La forma del botón. El valor por defecto es rectangular . Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	shape: "rectangular"

La siguiente tabla enumera las formas de botón disponibles y sus descripciones:

Forma
rectangular	El botón de forma rectangular. Si se utiliza para el icon tipo botón, entonces es el mismo que el square .
pill	El botón con forma de pastilla. Si se utiliza para el icon tipo botón, entonces es el mismo que el circle .
circle	El botón en forma de círculo. Si se utiliza para el standard tipo botón, entonces es lo mismo que pill .
square	El botón de forma cuadrada. Si se utiliza para el standard tipo botón, entonces es el mismo que el rectangular .

logo_alignment

La alineación del logotipo de Google. El valor por defecto se left . Este atributo sólo se aplica a la standard de tipo botón. Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	logo_alignment: "center"

La siguiente tabla enumera las alineaciones disponibles y sus descripciones:

logo_alignment
left	Alinea a la izquierda el logotipo de Google.
center	Alinea al centro el logotipo de Google.

ancho

El ancho mínimo del botón, en píxeles. El ancho máximo es de 400 píxeles.

Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	width: 400

lugar

La configuración regional preestablecida del texto del botón. Si no está configurado, se utiliza la configuración regional predeterminada del navegador o la preferencia del usuario de la sesión de Google. Por lo tanto, diferentes usuarios pueden ver diferentes versiones de botones localizados y posiblemente con diferentes tamaños.

Consulte la siguiente tabla para obtener más información:

Escribe	Requerido	Ejemplo
cuerda	Opcional	locale: "zh_CN"

Tipo de datos: credencial

Cuando su native_callback se invoca la función, una Credential objeto se pasa como parámetro. La siguiente tabla enumera los campos contenidos en el objeto:

Campo
id	Identifica al usuario.
password	La contraseña

Método: google.accounts.id.disableAutoSelect

Cuando el usuario fuera de su sitio web, es necesario llamar al método google.accounts.id.disableAutoSelect para registrar el estado de las cookies. Esto evita un bucle muerto de UX. Vea el siguiente fragmento de código del método:

google.accounts.id.disableAutoSelect()

El siguiente código de ejemplo implementa la google.accounts.id.disableAutoSelect método con un onSignout() Función:

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

Método: google.accounts.id.storeCredential

Este método es un simple envoltorio para la store() método de la API de administrador de credenciales nativo del navegador. Por lo tanto, solo se puede utilizar para almacenar una credencial de contraseña. Vea el siguiente ejemplo de código del método:

google.accounts.id.storeCredential(Credential, callback)

El siguiente código de ejemplo implementa la google.accounts.id.storeCredential método con un onSignIn() Función:

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

Método: google.accounts.id.cancel

Puede cancelar el flujo de One Tap si elimina el mensaje del DOM de la parte que confía. La operación de cancelación se ignora si ya se ha seleccionado una credencial. Vea el siguiente ejemplo de código del método:

google.accounts.id.cancel()

El siguiente ejemplo implementos de código de la google.accounts.id.cancel() método con un onNextButtonClicked() de función:

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

Devolución de llamada de carga de biblioteca: onGoogleLibraryLoad

Puede registrar una onGoogleLibraryLoad de devolución de llamada. Se notifica después de que se cargue la biblioteca de JavaScript Iniciar sesión con Google:

window.onGoogleLibraryLoad = () => {
    ...
};

Esta devolución de llamada es sólo un atajo para la window.onload de devolución de llamada. No hay diferencias de comportamiento.

El siguiente código de ejemplo implementa un onGoogleLibraryLoad de devolución de llamada:

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

Método: google.accounts.id.revoke

El google.accounts.id.revoke método revoca la concesión OAuth utilizado para compartir el ID de símbolo para el usuario especificado. Véase el siguiente fragmento de código del método: google.accounts.id.revoke(hint, callback)

Parámetro	Escribe	Descripción
hint	cuerda	La dirección de correo electrónico o el ID único de la cuenta de Google del usuario. El ID es el sub propiedad de la credencial de carga útil.
callback	función	Opcional RevocationResponse manejador.

El siguiente ejemplo muestra cómo código utilizan el revoke método con un Id.

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

Punto clave: llamar a este método revoca todas OAuth2 alcances previamente concedida por el signo En la biblioteca de cliente Con Google.

Tipo de datos: RevocationResponse

Cuando su callback se invoca la función, un RevocationResponse objeto se pasa como parámetro. La siguiente tabla enumera los campos que están contenidos en el objeto de respuesta de revocación:

Campo
successful	Este campo es el valor de retorno de la llamada al método.
error	Este campo contiene opcionalmente un mensaje de respuesta de error detallado.

exitoso

Este campo es un valor booleano establecido en verdadero si la llamada al método de revocación se realizó correctamente o falso en caso de error.

error

Este campo es un valor de cadena y contiene un mensaje de error detallado si la llamada al método de revocación falló, no está definido en caso de éxito.