Tempusxr English
Menu
  1. Documentation
  2. Construire avec le SDK

Statistiques de base

Sachez combien de personnes ouvrent une expérience, ce qu'elles regardent, ce qu'elles touchent, et pendant combien de temps. Les statistiques envoient quatre sortes d'événements et rien sur la personne.

C'est désactivé par défaut : rien n'est envoyé sans endpoint.

L'activer

Avec loadScene(), une option :

const experience = await loadScene('https://example.com/s/abc123/scene.json', {
  container: '#ar',
  analytics: { endpoint: 'https://a.example.com/e' },
});

Sans fichier de scène, branchez-les sur n'importe quelle expérience :

import { createAnalytics } from '@tempusxr/sdk-core';

const analytics = createAnalytics({ endpoint: 'https://a.example.com/e', scene: 'abc123' });
const experience = await loadScene(url, { container: '#ar', onEvent: analytics.onEvent });

Pour voir les événements pendant que vous construisez, ouvrez l'exemple de scène avec ?analytics sur le serveur de développement (pnpm dev) : il affiche ce qu'il reçoit.

Ce qui est mesuré

ÉvénementQuandChamp en plus
openedL'expérience a démarré (après start()). Une fois par visite.
foundUne cible est trouvée. À chaque fois, pour que le nombre dise combien on la regarde.target
tapUn toucher a lancé un comportement.node
timeSecondes passées dans l'expérience, envoyées toutes les 15 secondes tant que la page est visible, et une dernière fois quand la page est cachée ou fermée.seconds depuis le dernier time

Chaque événement porte scene (l'identifiant de la scène), visit et at (millisecondes depuis 1970). Rien d'autre.

Ce qui est envoyé

Les événements sont groupés et envoyés à votre endpoint par un POST, de type application/json :

{
  "v": 1,
  "events": [
    { "type": "opened", "scene": "abc123", "visit": "9f3c0a1b7e2d4c58", "at": 1793536000000 },
    { "type": "found", "scene": "abc123", "visit": "9f3c0a1b7e2d4c58", "at": 1793536003210, "target": "poster" },
    { "type": "time", "scene": "abc123", "visit": "9f3c0a1b7e2d4c58", "at": 1793536018000, "seconds": 15 }
  ]
}

Votre serveur répond 204. Toute autre réponse est ignorée.

Vie privée

Options

OptionCe qu'elle fait
endpointOù vont les lots. Sans elle, rien n'est envoyé.
sceneL'identifiant de la scène. loadScene le remplit.
consentUne fonction qui dit si vous pouvez collecter.
respectPrivacySignalsVrai par défaut.
batchSizeÉvénements envoyés ensemble au plus. 20 par défaut.
flushMsLe plus long qu'un événement attend avant d'être envoyé. 5000 par défaut.
timeMsÀ quelle cadence time est envoyé. 15000 par défaut.
maxQueueÉvénements gardés en attente. Les plus anciens sont perdus au-delà. 100 par défaut.

Cela ne gêne jamais

Le client est créé au démarrage de l'expérience et ne touche jamais la boucle d'images. Il envoie avec navigator.sendBeacon (donc ça marche encore quand la page se ferme) et retombe sur fetch avec keepalive. Un envoi qui échoue est ignoré : pas de nouvel essai, pas d'erreur dans votre expérience. Le temps d'une page cachée n'est pas compté.

Le service qui collecte ne fait pas encore partie du SDK. Il viendra avec le serveur du Viewer. Le format ci-dessus est le contrat.