Skip to content

Commit c85996e

Browse files
committed
docs: update tracking document with expo-router example
1 parent 22ba8a2 commit c85996e

File tree

6 files changed

+236
-140
lines changed
  • website
    • docs/application
    • i18n
      • de/docusaurus-plugin-content-docs/current/application
      • fr/docusaurus-plugin-content-docs/current/application
      • id/docusaurus-plugin-content-docs/current/application
      • ja/docusaurus-plugin-content-docs/current/application
      • zh-Hans/docusaurus-plugin-content-docs/current/application

6 files changed

+236
-140
lines changed

website/docs/application/tracking.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,22 @@ reportApplicationScreenView();
7878
reportApplicationScreenView('Checkout', { cartItems: 3 });
7979
```
8080

81+
#### Intergate with expo-router
82+
83+
```tsx
84+
import { useGlobalSearchParams, usePathname } from 'expo-router'
85+
import { reportApplicationScreenView } from 'tianji-react-native'
86+
87+
function App() {
88+
const pathname = usePathname()
89+
const params = useGlobalSearchParams()
90+
91+
useEffect(() => {
92+
reportApplicationScreenView(pathname, params)
93+
}, [pathname, params])
94+
}
95+
```
96+
8197
## User Identification
8298

8399
Identify users in your application to track their behavior across sessions:
Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
sidebar_position: 1
3-
_i18n_hash: ae151f338aa838eaab15a19bfea78d7f
3+
_i18n_hash: fbe38264a49d1d3af45c4417fdc9a108
44
---
5-
# Anwendungstracking
5+
# Anwendungs-Tracking
66

7-
Tianji bietet ein leistungsstarkes SDK zum Verfolgen von Ereignissen und Benutzerverhalten in Ihren Anwendungen. Diese Anleitung erklärt, wie Sie das Application Tracking SDK in Ihre Projekte integrieren und verwenden.
7+
Tianji bietet ein leistungsstarkes SDK zur Verfolgung von Ereignissen und Benutzerverhalten in Ihren Anwendungen. Diese Anleitung erklärt, wie Sie das Application Tracking SDK in Ihre Projekte integrieren und verwenden.
88

99
## Installation
1010

@@ -20,28 +20,28 @@ pnpm add tianji-react-native
2020

2121
## Initialisierung
2222

23-
Bevor Sie Tracking-Funktionen verwenden, müssen Sie das Application SDK mit Ihrer Tianji-Server-URL und der Anwendungs-ID initialisieren:
23+
Bevor Sie Tracking-Funktionen nutzen können, müssen Sie das Application SDK mit Ihrer Tianji-Server-URL und Anwendungs-ID initialisieren:
2424

2525
```ts
2626
import { initApplication } from 'tianji-react-native';
2727

2828
initApplication({
2929
serverUrl: 'https://tianji.example.com', // Ihre Tianji-Server-URL
30-
applicationId: 'your-application-id' // Ihre Anwendungs-ID
30+
applicationId: 'your-application-id' // Ihre Anwendungs-ID
3131
});
3232
```
3333

34-
## Ereignisverfolgung
34+
## Ereignis-Tracking
3535

3636
Sie können benutzerdefinierte Ereignisse in Ihrer Anwendung verfolgen, um Benutzeraktionen und -verhalten zu überwachen:
3737

3838
```ts
3939
import { reportApplicationEvent } from 'tianji-react-native';
4040

41-
// Einfaches Ereignis verfolgen
41+
// Ein einfaches Ereignis verfolgen
4242
reportApplicationEvent('Button Clicked');
4343

44-
// Ereignis mit zusätzlichen Daten verfolgen
44+
// Ein Ereignis mit zusätzlichen Daten verfolgen
4545
reportApplicationEvent('Purchase Completed', {
4646
productId: 'product-123',
4747
price: 29.99,
@@ -51,11 +51,11 @@ reportApplicationEvent('Purchase Completed', {
5151

5252
## Bildschirmverfolgung
5353

54-
Verfolgen Sie Bildschirmaufrufe in Ihrer Anwendung, um Benutzer-Navigationsmuster zu verstehen:
54+
Verfolgen Sie Bildschirmansichten in Ihrer Anwendung, um Navigationsmuster der Benutzer zu verstehen:
5555

5656
### Aktuellen Bildschirm festlegen
5757

58-
Sie können die aktuellen Bildschirminformationen festlegen, die in nachfolgenden Ereignissen enthalten sind:
58+
Sie können die aktuellen Bildschirmdaten festlegen, die in nachfolgenden Ereignissen enthalten sein werden:
5959

6060
```ts
6161
import { updateCurrentApplicationScreen } from 'tianji-react-native';
@@ -64,33 +64,49 @@ import { updateCurrentApplicationScreen } from 'tianji-react-native';
6464
updateCurrentApplicationScreen('ProductDetails', { productId: 'product-123' });
6565
```
6666

67-
### Bildschirmansichten berichten
67+
### Bildschirmansichten melden
6868

69-
Berichten Sie explizit über Bildschirmansichtsereignisse:
69+
Bildschirmansicht-Ereignisse explizit melden:
7070

7171
```ts
7272
import { reportApplicationScreenView } from 'tianji-react-native';
7373

74-
// Aktuelle Bildschirmansicht berichten
74+
// Aktuelle Bildschirmansicht melden
7575
reportApplicationScreenView();
7676

77-
// Oder eine spezifische Bildschirmansicht berichten
77+
// Oder eine bestimmte Bildschirmansicht melden
7878
reportApplicationScreenView('Checkout', { cartItems: 3 });
7979
```
8080

81+
#### Integration mit expo-router
82+
83+
```tsx
84+
import { useGlobalSearchParams, usePathname } from 'expo-router'
85+
import { reportApplicationScreenView } from 'tianji-react-native'
86+
87+
function App() {
88+
const pathname = usePathname()
89+
const params = useGlobalSearchParams()
90+
91+
useEffect(() => {
92+
reportApplicationScreenView(pathname, params)
93+
}, [pathname, params])
94+
}
95+
```
96+
8197
## Benutzeridentifikation
8298

8399
Identifizieren Sie Benutzer in Ihrer Anwendung, um ihr Verhalten über Sitzungen hinweg zu verfolgen:
84100

85101
```ts
86102
import { identifyApplicationUser } from 'tianji-react-native';
87103

88-
// Identifizieren Sie einen Benutzer mit seinen Informationen
104+
// Einen Benutzer mit dessen Informationen identifizieren
89105
identifyApplicationUser({
90-
id: 'user-123', // Eindeutiger Benutzeridentifikator
106+
id: 'user-123', // Eindeutige Benutzerkennung
91107
92108
name: 'John Doe',
93-
// Fügen Sie beliebige andere Benutzereigenschaften hinzu
109+
// Weitere Benutzerattribute hinzufügen
94110
plan: 'premium',
95111
signupDate: '2023-01-15'
96112
});
@@ -105,12 +121,12 @@ Initialisiert das Application Tracking SDK.
105121
**Parameter:**
106122

107123
- `options`: ApplicationTrackingOptions
108-
- `serverUrl`: Ihre Tianji-Server-URL (z.B. 'https://tianji.example.com')
124+
- `serverUrl`: Ihre Tianji-Server-URL (z. B. 'https://tianji.example.com')
109125
- `applicationId`: Ihre Anwendungs-ID
110126

111127
### `reportApplicationEvent(eventName, eventData?, screenName?, screenParams?)`
112128

113-
Sendet ein Anwendungsereignis an den Tianji-Server.
129+
Sendet ein Anwendungsevent an den Tianji-Server.
114130

115131
**Parameter:**
116132

@@ -121,16 +137,16 @@ Sendet ein Anwendungsereignis an den Tianji-Server.
121137

122138
### `updateCurrentApplicationScreen(name, params)`
123139

124-
Aktualisiert die Informationen zum aktuellen Anwendungsbildschirm.
140+
Aktualisiert die Informationen zum aktuellen Anwendungsscreen.
125141

126142
**Parameter:**
127143

128144
- `name`: Bildschirmname
129-
- `params`: Bildschirmparameterobjekt
145+
- `params`: Bildschirmparameter-Objekt
130146

131147
### `reportApplicationScreenView(screenName?, screenParams?)`
132148

133-
Sendet ein Bildschirmansichtsereignis an den Tianji-Server.
149+
Sendet ein Bildschirmansicht-Ereignis an den Tianji-Server.
134150

135151
**Parameter:**
136152

@@ -143,11 +159,11 @@ Identifiziert einen Benutzer in der Anwendung.
143159

144160
**Parameter:**
145161

146-
- `userInfo`: Datenobjekt zur Benutzeridentifikation
162+
- `userInfo`: Benutzeridentifikationsdaten-Objekt
147163

148-
## Nutzlastbeschränkungen
164+
## Payload-Beschränkungen
149165

150-
- Sprachinformationen: max. 35 Zeichen
151-
- Betriebssysteminformationen: max. 20 Zeichen
152-
- URL-Informationen: max. 500 Zeichen
166+
- Sprachinformation: max. 35 Zeichen
167+
- Betriebssysteminformation: max. 20 Zeichen
168+
- URL-Information: max. 500 Zeichen
153169
- Ereignisname: max. 50 Zeichen
Lines changed: 47 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
sidebar_position: 1
3-
_i18n_hash: ae151f338aa838eaab15a19bfea78d7f
3+
_i18n_hash: fbe38264a49d1d3af45c4417fdc9a108
44
---
5-
# Suivi des Applications
5+
# Suivi d'Application
66

7-
Tianji fournit un SDK puissant pour suivre les événements et le comportement des utilisateurs dans vos applications. Ce guide explique comment intégrer et utiliser le SDK de Suivi d'Applications dans vos projets.
7+
Tianji fournit un puissant SDK pour le suivi des événements et du comportement des utilisateurs dans vos applications. Ce guide explique comment intégrer et utiliser le SDK de suivi d'application dans vos projets.
88

99
## Installation
1010

11-
Installez le SDK react native de Tianji dans votre projet :
11+
Installez le SDK Tianji react native dans votre projet :
1212

1313
```bash
1414
npm install tianji-react-native
@@ -20,14 +20,14 @@ pnpm add tianji-react-native
2020

2121
## Initialisation
2222

23-
Avant d'utiliser les fonctionnalités de suivi, vous devez initialiser le SDK d'Application avec l'URL de votre serveur Tianji et l'ID de votre application :
23+
Avant d'utiliser les fonctionnalités de suivi, vous devez initialiser le SDK d'application avec l'URL de votre serveur Tianji et l'ID de votre application :
2424

2525
```ts
2626
import { initApplication } from 'tianji-react-native';
2727

2828
initApplication({
29-
serverUrl: 'https://tianji.example.com', // Votre URL de serveur Tianji
30-
applicationId: 'votre-id-application' // Votre identifiant d'application
29+
serverUrl: 'https://tianji.example.com', // Votre URL du serveur Tianji
30+
applicationId: 'votre-id-application' // Identifiant de votre application
3131
});
3232
```
3333

@@ -39,11 +39,11 @@ Vous pouvez suivre des événements personnalisés dans votre application pour s
3939
import { reportApplicationEvent } from 'tianji-react-native';
4040

4141
// Suivre un événement simple
42-
reportApplicationEvent('Clic sur le bouton');
42+
reportApplicationEvent('Button Clicked');
4343

4444
// Suivre un événement avec des données supplémentaires
45-
reportApplicationEvent('Achat complété', {
46-
productId: 'produit-123',
45+
reportApplicationEvent('Purchase Completed', {
46+
productId: 'product-123',
4747
price: 29.99,
4848
currency: 'USD'
4949
});
@@ -55,42 +55,58 @@ Suivez les vues des écrans dans votre application pour comprendre les schémas
5555

5656
### Définir l'Écran Actuel
5757

58-
Vous pouvez définir l'information de l'écran actuel qui sera incluse dans les événements suivants :
58+
Vous pouvez définir les informations de l'écran actuel qui seront incluses dans les événements suivants :
5959

6060
```ts
6161
import { updateCurrentApplicationScreen } from 'tianji-react-native';
6262

6363
// Mettre à jour l'écran actuel lorsque l'utilisateur navigue
64-
updateCurrentApplicationScreen('DétailsDuProduit', { productId: 'produit-123' });
64+
updateCurrentApplicationScreen('ProductDetails', { productId: 'product-123' });
6565
```
6666

67-
### Reporting des Vues d'Écran
67+
### Compte Rendu des Vues d'Écran
6868

6969
Rapportez explicitement les événements de vue d'écran :
7070

7171
```ts
7272
import { reportApplicationScreenView } from 'tianji-react-native';
7373

74-
// Rapporter la vue de l'écran actuel
74+
// Rapport sur la vue de l'écran actuel
7575
reportApplicationScreenView();
7676

77-
// Ou rapporter une vue d'écran spécifique
78-
reportApplicationScreenView('Commande', { cartItems: 3 });
77+
// Ou rapport sur une vue d'écran spécifique
78+
reportApplicationScreenView('Checkout', { cartItems: 3 });
7979
```
8080

81-
## Identification des Utilisateurs
81+
#### Intégration avec expo-router
82+
83+
```tsx
84+
import { useGlobalSearchParams, usePathname } from 'expo-router'
85+
import { reportApplicationScreenView } from 'tianji-react-native'
86+
87+
function App() {
88+
const pathname = usePathname()
89+
const params = useGlobalSearchParams()
90+
91+
useEffect(() => {
92+
reportApplicationScreenView(pathname, params)
93+
}, [pathname, params])
94+
}
95+
```
96+
97+
## Identification de l'Utilisateur
8298

8399
Identifiez les utilisateurs dans votre application pour suivre leur comportement à travers les sessions :
84100

85101
```ts
86102
import { identifyApplicationUser } from 'tianji-react-native';
87103

88-
// Identifier un utilisateur avec leurs informations
104+
// Identifiez un utilisateur avec ses informations
89105
identifyApplicationUser({
90-
id: 'utilisateur-123', // Identifiant unique de l'utilisateur
91-
email: 'utilisateur@exemple.com',
106+
id: 'user-123', // Identifiant unique de l'utilisateur
107+
email: 'user@example.com',
92108
name: 'John Doe',
93-
// Ajouter d'autres propriétés utilisateur
109+
// Ajoutez d'autres propriétés utilisateur
94110
plan: 'premium',
95111
signupDate: '2023-01-15'
96112
});
@@ -105,7 +121,7 @@ Initialise le SDK de suivi d'application.
105121
**Paramètres :**
106122

107123
- `options`: ApplicationTrackingOptions
108-
- `serverUrl`: URL de votre serveur Tianji (ex. 'https://tianji.example.com')
124+
- `serverUrl`: Votre URL du serveur Tianji (ex : 'https://tianji.example.com')
109125
- `applicationId`: Identifiant de votre application
110126

111127
### `reportApplicationEvent(eventName, eventData?, screenName?, screenParams?)`
@@ -115,13 +131,13 @@ Envoie un événement d'application au serveur Tianji.
115131
**Paramètres :**
116132

117133
- `eventName`: Nom de l'événement (max 50 caractères)
118-
- `eventData`: (Optionnel) Objet de données d'événement
134+
- `eventData`: (Optionnel) Objet de données de l'événement
119135
- `screenName`: (Optionnel) Nom de l'écran pour remplacer l'écran actuel
120-
- `screenParams`: (Optionnel) Paramètres de l'écran pour remplacer les paramètres d'écran actuels
136+
- `screenParams`: (Optionnel) Paramètres de l'écran pour remplacer les paramètres de l'écran actuel
121137

122138
### `updateCurrentApplicationScreen(name, params)`
123139

124-
Met à jour l'information de l'écran d'application actuel.
140+
Met à jour les informations de l'écran de l'application actuelle.
125141

126142
**Paramètres :**
127143

@@ -135,19 +151,19 @@ Envoie un événement de vue d'écran au serveur Tianji.
135151
**Paramètres :**
136152

137153
- `screenName`: (Optionnel) Nom de l'écran pour remplacer l'écran actuel
138-
- `screenParams`: (Optionnel) Paramètres de l'écran pour remplacer les paramètres d'écran actuels
154+
- `screenParams`: (Optionnel) Paramètres de l'écran pour remplacer les paramètres de l'écran actuel
139155

140156
### `identifyApplicationUser(userInfo)`
141157

142158
Identifie un utilisateur dans l'application.
143159

144160
**Paramètres :**
145161

146-
- `userInfo`: Objet de données d'identification utilisateur
162+
- `userInfo`: Objet de données d'identification de l'utilisateur
147163

148-
## Limites de Chargement
164+
## Limitations des Charges Utiles
149165

150-
- Information de langue : max 35 caractères
151-
- Information du système d'exploitation : max 20 caractères
152-
- Information URL : max 500 caractères
166+
- Informations sur la langue : max 35 caractères
167+
- Informations sur le système d'exploitation : max 20 caractères
168+
- Informations sur l'URL : max 500 caractères
153169
- Nom de l'événement : max 50 caractères

0 commit comments

Comments
 (0)