Événements courants

page_view

La méthode page_view appel vous permet d'enregistrer chaque fois qu'un utilisateur voit une page de votre site web, ainsi que toutes les propriétés optionnelles concernant la page.

Paramètres (requises et recommandés)

Nom	Type	Requis	Valeur Exemple	Description
page_type	string	Oui	product_list	Catégorie de page. Types prédéfinis recommandés : home landing product_list product content_list content search funnel success funnel_confirmation account cart legal (ex. Politique de confidentialité) Équivalent à tc_vars.env_template
page_name	string	Non	Suggestion pour la Fête des Mères	Nom de la page.
user	Object<User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).
type (déprécié)	string	Non	product_list	Catégorie de page.

Paramètres ajoutés automatiquement par l'API cact pour les sources web

Nom	Type	Requis	Valeur Exemple	Description
user	Object <User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).
title	string	Non	Products - MySite.com	Titre de la page :document.title depuis l'API DOM
url	string	Non	http://www.mysite.com	URL complète de la page. Équivalent àlocation.href depuis l'API DOM.
path	string	Non	/products/mothers	Partie chemin de l'URL de la page : location.pathname depuis l'API DOM.
referrer	string	Non	http://www.example.com	URL complète de la page précédente : document.referrer depuis l'API DOM.

Exemple

JavaScript

cact('trigger','page_view', {
  page_type: 'product_list',
  page_name: 'Best sellers',
  user: {
    id: '12356',
    email:'[email protected]',
    consent_categories: [1,3]
  }
});

Kotlin (Android)

val event = TCPageViewEvent("product_list")
event.pageName = "Best sellers"
serverside.execute(event)

Java (Android)

TCPageViewEvent event = new TCPageViewEvent("product_list")
event.pageName = "Best sellers";
serverside.execute(event);

Objective-C (iOS)

TCPageViewEvent *event = [[TCPageViewEvent alloc] init];
event.pageType = @"product_list";
event.pageName = @"Best sellers";
[TCS execute: event];

//ou vous pouvez aussi l'utiliser dans un constructeur, comme suit :
TCPageViewEvent *event = [[TCPageViewEvent alloc] initWithType: @"type"];

Swift (iOS)

let event = TCPageViewEvent(type: "product list")
	event?.pageName = "Best sellers"
	serverside?.execute(event)

Dart (Flutter)

var event = TCPageViewEvent();
    event.pageName = "event_page_name";
    event.pageType = "event_page_type";
    serverside.execute(event);

json

{
    "event_name": "page_view", 
        "page_type": "product_list",
        "page_name": "Best sellers"   
}

login

Envoyez cet événement pour signifier qu'un utilisateur s'est connecté.

Paramètres

Nom	Type	Requis	Exemple	Description
method	string	Non	LinkedIn	La méthode utilisée pour se connecter.
user	Object<User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).

Exemple

JavaScript

cact('trigger', 'login', {
  method: 'LinkedIn',
  user: {
    id: '12356',
    email:'[email protected]',
    consent_categories: [1,3]
  }
});

Kotlin (Android)

val event = TCLoginEvent()
event.method = "LinkedIn"
serverside.execute(event)

Java (Android)

TCLoginEvent event = new TCLoginEvent();
event.method = "LinkedIn";
serverside.execute(event);

Objective-C (iOS)

TCLoginEvent *event = [[TCLoginEvent alloc] init];
event.method = @"LinkedIn";
[TCS execute: event];

Swift (iOS)

let event = TCLoginEvent()
	event.method = "linkedin"
	serverside?.execute(event)

Dart (Flutter)

var event = TCLoginEvent();
    event.method = "LinkedIn";
    serverside.execute(event);

json

{
    "event_name": "login",
        "method": "LinkedIn"
}

search

Utilisez cet event pour contextualiser les opérations de recherche. Cet event peut vous aider à identifier le contenu le plus populaire dans votre app.

Paramètres

Nom	Type	Requis	Valeur exemple	Description
search_term	string	Oui	t-shirts	Le terme qui a été recherché.
user	Object<User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).

Exemple

JavaScript

cact('trigger','search', {
  search_term: 't-shirts',
  user: {
    id: '12356',
    email:'[email protected]',
    consent_categories: [1,3]
  }
});

Kotlin (Android)

val event = TCSearchEvent("t-shirts")
serverside.execute(event)

Java (Android)

TCSearchEvent event = new TCSearchEvent("t-shirts");
serverside.execute(event);

Objective-C (iOS)

TCSearchEvent *event = [[TCSearchEvent alloc] init];
event.searchTerm = @"t-shirts";
[TCS execute: event];

Swift (iOS)

let event = TCSearchEvent(searchTerm: "t-shirts")
    serverside.execute(event)

Dart (Flutter)

var event = TCSearchEvent();
    event.searchTerm = "t-shirts";
    serverside.execute(event);

json

{
    "event_name": "search",
        "search_term": "t-shirts"
}

select_content

Cet event signifie qu'un utilisateur a sélectionné du contenu d'un certain type. Cet event peut vous aider à identifier le contenu populaire et les catégories de contenu dans votre app ou cliquer sur une promotion interne.

Paramètres

Nom	Type	Requis	Valeur exemple	Description
content_type	string	Non	product	Le type de contenu sélectionné.
item_id	string	Non	I_12345	Un identifiant pour l'article qui a été sélectionné.
user	Object<User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).

Exemple

JavaScript

cact('trigger','select_content', {
  content_type: 'product',
  item_id: 'I_12345',
  user: {
    id: '12356',
    email:'[email protected]',
    consent_categories: [1,3]
  }
});

Kotlin (Android)

val event = TCSelectContentEvent()
event.contentType = "product"
serverside.execute(event)

Java (Android)

TCSelectContentEvent event = new TCSelectContentEvent();
event.contentType = "product";
serverside.execute(event);

Objective-C (iOS)

TCSelectContentEvent *event = [[TCSelectContentEvent alloc] init];
event.contentType = @"product";
event.itemID = @"I_12345";
[TCS execute: event];

Swift (iOS)

let event = TCSelectContentEvent()
	event.contentType = "product"
	event.itemID = "I_12345"
	serverside?.execute(event)

Dart (Flutter)

var event = TCSelectContentEvent();
    event.contentType = "product";
    event.itemId = "I_12345";
    serverside.execute(event);

json

{
    "event_name": "select_content",
        "content_type": "product",
        "item_id": "I_12345"
}

sign_up

Cet event indique qu'un utilisateur s'est inscrit pour un compte.

Paramètres (requis et recommandé)

Nom	Type	Requis	Exemple	Description
method	string	Non	Facebook	La méthode utilisée pour l'inscription.
user	Object<User>	Oui	{ id: '12345', email: '[email protected]', consent_categories: [1,3] }	consent_categories est la liste des consentements de l'utilisateur. Elle est automatiquement remplie depuis les sources web si vous utilisez Commanders Act CMP. Vous devez également ajouter toutes les propriétés de l'utilisateur dans cet objet user, en particulier la clé de réconciliation (id, email).

Exemple

Javascript

cact('trigger','sign_up', {
  method: 'email',
  user: {
    id: '12356',
    email:'[email protected]',
    consent_categories: [1,3]
  }
});

Kotlin (Android)

val event = TCSignUpEvent()
event.method = "email"
serverside.execute(event)

Java (Android)

TCSignUpEvent event = new TCSignUpEvent();
event.method = "email";
serverside.execute(event);

iOS

TCSignUpEvent *event = [[TCSignUpEvent alloc] init];
event.method = @"email";
[TCS execute: event];

Swift

let event = TCSignUpEvent()
	event.method = "email"
	serverside?.execute(event)

Flutter

var event = TCSignUpEvent();
    event.method = "email";
    serverside.execute(event);

json

{
    "event_name": "sign_up",
        "method": "email"
}

- SCHÉMAS COURANTS -

User

Lorsque vous envoyez un event, il doit contenir suffisamment d'informations pour identifier quel utilisateur l'a émis. Nous pouvons relier les events entre eux en utilisant des cookies. Mais les partenaires de destination exigent des identifiants précis pour effectuer des actions.

id et email sont généralement les paramètres les plus utiles. Bien que certains partenaires de destination utilisent aussi firstname, lastname, birthdate, city, ...

Vous n'aurez pas toujours tous ces paramètres. Mais il est recommandé de les envoyer dès que possible pendant la navigation de l'utilisateur.

Paramètres (requis et recommandé)

Nom	Type	Requis	Valeur Exemple	Description
id	string	Non*	845454	User's main identifier (e.g. CRM id) (*) requis pour de nombreuses destinations et le traitement interne.
email	string	Yes*	[email protected]	Email (valeur simple) (*) requis pour de nombreuses destinations et le traitement interne. Pas requis si email_sha256 est fourni
email_md5	string	Non*	8eb1b52... (taille 32)	Email, haché en utilisant MD5 algorithm. Pas requis si email est fourni (voir ci-dessous)
email_sha256	string	Non*	836f82d... (taille 64)	Email, haché en utilisant SHA-256 algorithm. Pas requis si email est fourni (voir ci-dessous)
phone	string	Non*	[phone]	Numéro de téléphone, E.164 format (*) requis pour certaines destinations.
firstname	string	Non	John	Prénom
lastname	string	Non	Doe	Nom de famille
gender	string	Non	m	Genre f pour Femme m pour Homme
birthdate	string	Non	1970-01-01	Date de naissance, YYYY-MM-DD format
city	string	Non	Boston	Ville
state	string	Non	Massachusetts	État
zipcode	string	Non	02108	Code postal
country	string	Non	USA	Code pays, ISO 3166-1 2-letter ou 3-letter formats
consent_categories	Array	Oui	[1,2,3]	Catégories de consentement de l'utilisateur. Nécessaire pour autoriser le partage de données avec les partenaires de destination. Il est rempli automatiquement à partir des sources web si vous utilisez Commanders Act CMP.

À propos du hachage

Dans certains cas, vous ne pourrez pas envoyer un paramètre plain valeur. Elle est soit indisponible soit restreinte.

Ainsi il peut être possible d'envoyer les hashed valeurs. Nous acceptons actuellement 2 algorithmes : md5 et sha256.

Chaque user.<property> peut être envoyé sous format haché avec suffixe d'algorithme : _md5 ou _sha256 (underscore suivi du nom de l'algorithme en minuscules)

Exemple :

{
  user: {
    email_md5: '8eb1b522f60d11fa897de1dc6351b7e8',                                      // md5('[email protected]')
    email_sha256: '836f82db99121b3481011f16b49dfa5fbc714a0d1b1b9f784a1ebbbf5b39577f',   // sha256('[email protected]')
    phone_md5: '60dd761f55cb17f0532c9fb1679e8ddd',                                      // md5('[phone]')
    phone_sha256: '42d573cfc315801d4cd8eddd5416b416a0bf298b9b9e12d6b07442c91db42bd8',   // sha256('[phone]')
  }
}

ℹ️ nous ne supportons que l'encodage hexadécimal (base16) (c.-à-d. : hashed les valeurs sont transportées par des chaînes avec des caractères [0-9a-f]) Les autres encodages ne sont pas encore pris en charge

Pas besoin d'envoyer les deux plain et hashed valeurs :

• si vous envoyez plain value, le hashed les valeurs ne sont pas nécessaires Nous pouvons générer hashed values on server side using plain valeur

• si vous n'envoyez pas plain value, alors vous devriez remplir autant de hashed valeurs que possible Les partenaires exigent différents algorithmes de hachage et sans plain value, nous ne pouvons générer aucun hash. C'est pourquoi nous avons besoin de l'exact hashed valeur