SDK referencia

Cargando el Lia SDK, las propiedades del objeto Lia, cómo responden y fallan las llamadas, e un índice de cada método.

#Cargándolo

<script src="https://api.lialabs.org/sdk/lia-apps-v1.js"></script>

Cárgalo desde Lia, antes de tus propios scripts. Define un global, window.Lia, una vez (cargarlo dos veces no hace nada). Es'un JavaScript plano sin dependencias, y funciona con cualquier framework o sin ninguno. Esta página describe la versión 1.9.0.

En TypeScript, declare el global hasta que haya's un paquete de tipos:

declare global {
  interface Window { Lia: any }
}
const Lia = window.Lia;

#Cómo responden las llamadas

• La mayoría de los métodos devuelven una promesa. Se resuelve con la respuesta descrita para cada método, o se rechaza con un Error que tiene un code (y un message en inglés para ti, no para los jugadores).
• Malos argumentos también se rechazan, con un código como bad_text, antes de que nada llegue a Lia. Algunos métodos que no'no devolver promesas (Lia.inviteLink, Lia.on, los botones' (setters) lanzan en su lugar.
• Fuera de la aplicación Lia, cada llamada se rechaza con not_in_lia. Lia.available te lo dice desde el principio.
• Lia debe responder dentro de 20 segundos, o la llamada rechaza con timeout. Llamadas que esperan a la persona (la hoja de pago, anuncios, diálogos, el selector de amigos, la solicitud de notificaciones, el escáner, el portapapeles, Face ID, compartir) esperan tanto como sea necesario.

try {
  const result = await Lia.pay("extra-lives");
} catch (error) {
  switch (error.code) {
    case "cancelled": return; // they changed their mind
    case "not_in_lia": return showOpenInLia();
    default: Lia.toast("Something went wrong", { tone: "error" });
  }
}

Todo código está listado en Códigos de error.

#Propiedades

Leer estos después Lia.init() ha respondido; antes de eso, tienen valores predeterminados. La mayoría se mantienen actualizados mediante Lia'los eventos.

#Lia.isVersionAtLeast(version)

Si SDK es al menos esta versión, para características añadidas posteriormente.

if (Lia.isVersionAtLeast("1.3")) Lia.inviteFriend({ startParam: room });

Devuelve un booleano (no un promesa).

#CSS variables

Después init(), el SDK los coloca en tu página'la raíz y la mantiene actualizada: Lia'su tema (--lia-bg-color y el resto), --lia-color-scheme, --lia-viewport-height, --lia-safe-area-inset-* y --lia-content-safe-area-inset-*. Ver Aspecto y sensación.

#Cada método

#Viniendo de Telegram

Lia's SDK sigue a Telegram's Mini Aplicaciones donde se adapta, por lo que la mayoría de las ideas se trasladan:

#Análisis de la aplicación web

Lia.analytics (SDK 1.8) registra el uso opcional de la aplicación web en Lia Labs' OpenPanel proyecto. Funciona con las versiones actuales de iOS y Android. Esto es opción separada desde el interruptor de "Compartir datos de uso" de la aplicación nativa.

Cuando su página llama Lia.ready(), el SDK comprueba si el equipo ha habilitado las analíticas y pregunta una vez si este jugador no ha elegido para esta aplicación. Rechazar no envía eventos. Un pequeño botón de privacidad permite a la persona cambiar su elección más tarde. La elección se almacena por jugador y aplicación web en el servidor de Lia's. No se almacenan eventos de analíticas antes del consentimiento ni se reproducen después de rechazar.

• Lia.analytics.allowed: si esta página tiene actualmente permiso.
• Lia.analytics.requestConsent(): vuelve a abrir la elección de privacidad y responde true solo después de la autorización.
• Lia.analytics.disable(): detiene inmediatamente los envíos de esta página y guarda la opción de no participar.
• Lia.analytics.track(name, properties?): indica si se envió un evento; los fallos nunca detienen su juego. Los nombres usan letras minúsculas, dígitos y guiones bajos, comienzan con una letra y tienen como máximo 48 caracteres. Las propiedades permiten hasta 12 valores numéricos o booleanos, con claves de identificador en minúsculas de hasta 32 caracteres.

await Lia.init();
Lia.ready();
// Only sends when the person has already agreed. Never prompt during a round.
await Lia.analytics.track("round_finished", { level: 3, score: 120, won: true });

Los registros de SDK se abren y reanudan tras el consentimiento. Agrega tus propios nombres de eventos estáticos para los hitos del juego. No uses nombres, correos electrónicos, mensajes, URLs, texto libre o identificadores de cuenta como nombres de eventos. Las propiedades de texto son rechazadas. El recolector agrega la ID de la aplicación y el modo de producción/prueba, comprueba la sesión firmada, vuelve a comprobar el consentimiento, respeta el interruptor de análisis del equipo, y limita los eventos a 60 por jugador por aplicación por minuto. Transmite eventos agregados sin el ID de perfil del jugador, página URLs, valores de formulario o la dirección IP de la persona.

El rastreador usa POST /api/web-analytics/consent y /track con una sesión de aplicación firmada recién creada. Estos SDK-propios puntos finales no necesitan clave de desarrollador API. Las credenciales OpenPanel permanecen en el servidor de Lia.

Estos métodos de analítica están en el SDK alojado que se carga con una etiqueta script. Los enlaces de invitación y de mesas nunca abren automáticamente la solicitud de consentimiento; el botón de privacidad sigue disponible.

Traducido automáticamente. El inglés es la fuente de verdad. Leer en inglés