Spécificités des événements de l'application mobile

1. Mappage SDK des événements

2. Spécificités des événements pour l'application mobile

3. Détails des champs

4. device

5. appareil -> os

6. appareil -> écran

7. appareil -> réseau

8. appareil -> cycle de vie

9. app

Un événement complet est l'ajout d'informations spécifiques à l'événement et de données collectées par le SDK. Pour chaque événement, vous trouverez dans la documentation "référence des événements" toutes les propriétés possibles et celles obligatoires.

Mappage SDK des événements

Pour créer un événement, vous devrez utiliser les classes du SDK qui représentent les événements. Comme cela peut prêter à confusion, vous trouverez ici une liste des noms de classe et de leurs équivalents d'événement.

Tous ces noms de classe sont valides à la fois sur Android et iOS.

nom de l'événement	nom de classe
tout événement personnalisé	TCCustomEvent
add_payment_info	TCAddPaymentInfoEvent
add_shipping_info	TCAddShippingInfoEvent
add_to_cart	TCAddToCartEvent
add_to_wishlist	TCAddToWishlistEvent
begin_checkout	TCBeginCheckoutEvent
generate_lead	TCGenerateLeadEvent
login	TCLoginEvent
page_view	TCPageViewEvent
purchase	TCPurchaseEvent
refund	TCRefundEvent
remove_from_cart	TCRemoveFromCartEvent
search	TCSearchEvent
select_content	TCSelectContentEvent
select_item	TCSelectItemEvent
sign_up	TCSignUpEvent
view_cart	TCViewCartEvent
view_item	TCViewItem
view_item_list	TCViewItemListEvent

SCHÉMAS COMMUNS	nom de classe
Article	TCItem
Produit	TCProduct
Utilisateur	TCUser

VALEUR ÉNUMÉRÉE	Nom de classe
Méthodes de paiement	ETCPaymentMethod
Statut d'achat	ETCPurchaseStatus

Spécificités des événements pour l'application mobile

Les SDK iOS et Android ajoutent des propriétés spécifiques concernant l'appareil et l'application. Elles s'ajoutent aux propriétés gérées par l'événement.

Si vous suivez vos applications mobiles sans utiliser le sdk (avec le API de suivi HTTP), vous devez suivre cette spécification pour bénéficier du plug&play sur les destinations\

Voici un exemple de payload d'événement :

{
   "event_name":"add_to_cart",
   "value":22.53,
   "currency":"EUR",
   "user": {
	   "consistent_anonymous_id": "b5c6aa4e-0532-40c0-bf6b-a77bff46d600",
	   "email": "[e-mail]",
	   "consent_categories": ["1", "3"]
   },
   "items":[
      {
         "id":"SKU_12345",
         "quantity":1,
         "product":{
            "id":"12345",
            "name":"Trex tshirt",
            "price":9.99
         }
      }
   ],
   "context":{
      "event_id":"8f6e05dd-6df0-476c-9c56-5d277fac7cea",
      "device":{
         "sdk_id":"a47f71c0-9561-4a26-96d6-0d8632095caa",
         "user_agent":"Mozilla\/5.0 (Linux; Android 13; sdk_gphone64_arm64 Build\/TE1A.220922.012; wv) AppleWebKit\/537.36 (KHTML, like Gecko) Version\/4.0 Chrome\/103.0.5060.71 Mobile Safari\/537.36",
         "manufacturer":"Google",
         "model":"sdk_gphone64_arm64",
         "name":"emu64a",
         "type":"android",
         "language":"en",
         "region":"US",
         "network":{
            "bluetooth":false,
            "cellular":false,
            "wifi":true
         },
         "os":{
            "name":"android",
            "version":"13"
         },
         "screen":{
            "width":1080,
            "height":1857,
            "density":2.625
         },
         "timezone":"Europe\/Paris",
         "lifecycle":{
            "session_id":"5ab5fd16-5ebd-42bb-8c9c-b12564370c83",
            "new_session":false,
            "first_execute":false,
            "is_first_visit":true,
            "session_duration":138200,
            "current_session":1673571497826,
            "current_visit":1673571497826,
            "current_version_first_visit":1673571497826,
            "first_visit":1673571497826,
            "last_visit":1673571497826,
            "last_call":1673571632270,
            "last_session_start":0,
            "last_session_last_hit":0,
            "foreground_time":137652,
            "background_time":548,
            "foreground_transitions":2,
            "session_number":1,
            "visit_number":1,
            "is_prev_cycle_cleaned" :true
         }
      },
      "app":{
         "name":"TCDemo ServerSide And Consent",
         "version":"1.0",
         "build":"1",
         "namespace":"com.tagcommander.tcdemo",
         "core_version":"5.3.1",
	 "consent_version":"5.4.2",
         "serverside_version":"5.3.1"
      },
      "event_timestamp":1673571636026
   }
}

Détails des champs

Voici les champs ajoutés automatiquement par le SDK.

(*) L'adresse IP n'est pas collectée par nos bibliothèques, mais renseignée par nos serveurs lorsqu'ils reçoivent un message pour uniquement pour les événements client-side.

context

Nom du champ	Valeur d'exemple	Description	Plateforme
event_id	8f6e05dd-6df0-476c-9c56-5d277fac7cea	Un UUID aléatoire généré lors de la sérialisation de l'instance d'événement	Les deux
event_timestamp	1673571636026	Horodatage de l'heure d'envoi de l'événement.	Les deux

context.app

Nom du champ	Valeur d'exemple	Description	Plateforme
espace de noms	com.tagcommander.TCDemo	L'espace de noms de l'application	Les deux
name	TCDemo	Le nom de l'application	Les deux
build	1	L'ID de build de l'application	Les deux
version	1.1	La version de l'application	Les deux
serverside_version	5.1.0	La version du module server-side	Les deux
core_version	5.1.0	La version du module core	Les deux
consent_version	5.3.3	La version du module consent	Les deux

context.device

Nom du champ	Valeur d'exemple	Description	Plateforme
manufacturer	Apple	Le fabricant du matériel	Les deux
model	iPhone7.3	Le modèle de l'appareil	Les deux
name	maguro	Le nom donné à l'appareil	Les deux
sdk_id	C32272DB0-C21E-11E4-8DFC-AA07A5B093DB	Un UUID aléatoire généré lors du premier lancement du SDK et stocké sur l'appareil pour les lancements ultérieurs.	Les deux
timezone	Europe/Paris	Le fuseau horaire détaillé	Les deux
type	android	Le nom de l'OS	Les deux
language	en	La langue par défaut de l'appareil	Les deux
region	US	La région par défaut de l'appareil	Les deux
user_agent	Mozilla 5.0 (iPhone; ...	Le user agent de l'appareil ; le SDK iOS n'attend pas qu'il soit disponible par défaut.	Les deux

Les champs suivants nécessitent le consentement et sont ajoutés lorsque vous appelez "addAdvertisingIDs" depuis la classe ServerSide.

Nom du champ	Valeur d'exemple	Description	Plateforme
advertising_id	705EB54D-9FC7-4730-BF1B-A5D0494E1D8C	Either IDFA or AAD	Les deux
idfv	5E35A9BA-C945-4A79-80B6-D89139471308	IDFV	iOS
ad_tracking_enabled	true	L'utilisateur a-t-il activé le suivi publicitaire	Les deux

user

User contient tous les champs déclarés à l'intérieur https://doc.commandersact.com/developers/tracking/events-reference/common-events#user

Nom du champ	Valeur d'exemple	Description	Plateforme
consistent_anonymous_id	b5c6aa4e-0532-40c0-bf6b-a77bff46d600	ID généré pour le consentement, par défaut sdk_id ; nommé anonymous_id dans les classes Android/iOS pour l'édition.	Les deux
consent_categories	["1","2","10019","10018","13001"]	Liste des catégories acceptées	Les deux
ID	"anything"	Aucune valeur par défaut, mais peut être utilisé par le client s'il a besoin d'un ID spécifique	Les deux
consentID	b5c6aa4e-0532-40c0-bf6b-a77bff46d600	ID utilisé pour envoyer les informations de consentement. Par défaut, sdk_id;	Les deux
refused_vendors	["12","309","380"] ou "ALL"	liste des ID des fournisseurs refusés, pouvant être hachée, ou "ALL" comme valeur.	Les deux

context.device.os

Nom du champ	Valeur d'exemple	Description	Plateforme
name	ios	Le nom du système d'exploitation	Les deux
version	15.5	La version de l'OS	Les deux

context.device.screen

Nom du champ	Valeur d'exemple	Description	Plateforme
width	390	La largeur de l'écran de l'appareil	Les deux
height	844	La hauteur de l'écran de l'appareil	Les deux
density	2	La densité de l'écran de l'appareil	Android

context.device.network

Nom du champ	Valeur d'exemple	Description	Plateforme
bluetooth	false	Le Bluetooth est-il connecté	Les deux
cellular	true	La connexion cellulaire est-elle active	Les deux
carrier	T-Mobile US	Nom de l'opérateur (uniquement lorsque la connexion cellulaire est active)	Android
wifi	false	Le wifi est-il connecté	Android

context.device.lifecycle

Nom du champ	Valeur d'exemple	Description	Plateforme
session_id	F318C0D1-1DDB-4B53-9326-F2078A97CD38	Un ID spécifique à cette session	Les deux
new_session	false	Vrai si ce hit est le premier d'une nouvelle session	Les deux
session_duration	8291	Le temps passé durant cette session	Les deux
current_session	1655824764174	Horodatage du début de la session en cours	Les deux
visit_number	1	Nombre de fois que l'application a été lancée	Les deux
current_visit	1655824764174	Horodatage du début de la visite en cours	Les deux
current_version_first_visit	1655824764174	Horodatage de la première visite pour cette version de l'application	Les deux
session_number	1	Le nombre de sessions	Les deux
first_visit	1655824764174	Horodatage de la première visite de l'application	Les deux
last_visit	1655824764174	Horodatage de la dernière visite	Les deux
last_call	1655824772416	Horodatage du hit précédent	Les deux
last_session_start	0	Horodatage du début de la session précédente	Les deux
last_session_last_hit	0	Horodatage du dernier hit envoyé pendant la session précédente	Les deux
foreground_transitions	2	Nombre de fois où l'application est passée de l'arrière-plan au premier plan	Les deux
foreground_time	8278	Temps passé par l'application au premier plan	Les deux
background_time	0	Temps passé par l'application en arrière-plan	Les deux
first_execute	false	S'agit-il du premier hit de ce lancement à froid	Les deux
is_first_visit	true	S'agit-il du premier lancement de cette application. (avec first execute, vous pouvez valider une nouvelle installation)	Les deux
is_prev_cycle_cleaned	true	La session précédente s'est-elle terminée proprement (l'application a été fermée correctement et toutes les clés UserDefaults du SDK ont été enregistrées avec succès).	Les deux