Api
Référence API
Référence API complète pour le SDK Pixel Idlen
Référence API
Cette page est une référence rapide des commandes. Pour la matrice complète des options et le schéma payload, voir Référence des Événements.
Commandes
idlen('init', advertiserId, options?)
Initialise le pixel avec votre advertiser ID.
// Basique
idlen('init', 'adv_abc123');
// Avec options
idlen('init', 'adv_abc123', { debug: true });
| Paramètre | Type | Requis | Description |
|---|---|---|---|
advertiserId | string | Oui | Votre advertiser ID depuis l'Ads Manager |
options.debug | boolean | Non | Activer la journalisation console |
options.autoTrack | boolean | Non | Suivre automatiquement les changements d'URL |
options.trackHash | boolean | Non | Suivre les routes basées sur hash |
options.excludeRoutes | string[] | Non | Routes exclues du suivi |
options.endpoint | string | Non | Point de terminaison API personnalisé |
idlen('track', 'PageView')
Suit un événement de page vue.
idlen('track', 'PageView');
idlen('track', 'Conversion', data?)
Suit un événement de conversion.
// Conversion simple
idlen('track', 'Conversion');
// Conversion nommée
idlen('track', 'Conversion', { eventName: 'signup' });
// Conversion avec valeur
idlen('track', 'Conversion', {
eventName: 'purchase',
value: 99.99
});
| Paramètre | Type | Requis | Description |
|---|---|---|---|
data.eventName | string | Non | Nom d'événement personnalisé |
data.value | number | Non | Valeur monétaire |
idlen('track', 'NomEvenementPersonnalise', data?)
Suit des interactions personnalisées avec n'importe quel nom d'événement.
idlen('track', 'FeatureUsed', {
feature: 'export',
format: 'csv'
});
Payload des Événements
Les événements envoyés à l'API incluent :
| Champ | Type | Description |
|---|---|---|
aid | string | Advertiser ID |
vid | string | Visitor ID (UUID) |
et | string | Type d'événement (pageview, conversion) |
en | string? | Nom d'événement (pour les conversions) |
ev | number? | Valeur d'événement (pour les conversions) |
url | string | Chemin de la page |
ref | string? | Domaine référent |
ts | number | Horodatage (millisecondes) |
Types TypeScript
interface IdlenOptions {
debug?: boolean;
autoTrack?: boolean;
trackHash?: boolean;
excludeRoutes?: string[];
endpoint?: string;
}
interface ConversionData {
eventName?: string;
value?: number;
}
interface IdlenPixel {
(command: 'init', advertiserId: string, options?: IdlenOptions): void;
(command: 'track', eventType: 'PageView'): void;
(command: 'track', eventType: 'Conversion', data?: ConversionData): void;
(command: 'track', eventType: string, data?: Record<string, unknown>): void;
q?: any[];
}
declare global {
interface Window {
idlen?: IdlenPixel;
}
}
Réseau
Point de terminaison : POST https://pixel.idlen.io/v1/track
Méthode : Utilise navigator.sendBeacon() avec fallback vers fetch()
Limites de débit : 100 requêtes/minute par IP
Réponse : GIF transparent 1x1 (pour compatibilité)
Voir Référence des Événements pour le schéma complet et les limites.