Migrer depuis l'ancien SDK mobile

Comment migrer de l'ancien SDK plateforme (Platform 7) vers la nouvelle plateforme (Platform X)

Pour suivre une application mobile sur la nouvelle plateforme, vous pouvez soit installer notre nouveau SDK (Android et iOS) soit utiliser notre HTTP tracking API.

Étapes à suivre pour la migration du SDK v4 vers le SDK v5

Créez votre(s) Mobile Source(s)

Dans le Sources Catalog, créez vos nouvelles Sources. Sources > Overview > Add Source

À la dernière étape de la configuration de la Source, vous obtiendrez une Source Key, requise pour les méthodes d'initialisation de notre SDK

Remplacez les modules du SDK

Les fichiers de notre SDK ont changé. Vous devez remplacer les anciens. Obtenez nos dernières versions :

Android : https://github.com/CommandersAct/AndroidV5#latest-available-versions iOS : https://github.com/CommandersAct/iOSV5#latest-available-versions

Certains noms de nos modules ont également évolué, voici leurs correspondances :

TCSDK -> TCServerSide

TCPrivacy -> TCConsent

Modifiez les méthodes d'initialisation

La façon d'initialiser notre SDK est maintenant différente, vos anciennes méthodes ne seront plus reconnues.

• Vous n'avez plus besoin d'un container ID, tout est sur le même site ID. Au lieu d'un container ID, vous aurez besoin d'une clé spécifique pour définir la source.

• Vous n'avez plus besoin d'instancier une instance TCServerSide dans votre implémentation de Consent.

• Vous pourriez avoir besoin d'utiliser la classe TCUser pour transmettre les informations pertinentes concernant vos utilisateurs.

Voici un exemple de code que vous pouvez consulter ici :

https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#example https://github.com/CommandersAct/iosV5/tree/master/TCServerSide#example

Si votre application mobile utilise nos modules SDK uniquement pour la Privacy, votre migration est terminée à ce stade.

Si vous souhaitez bénéficier de tous les avantages du tracking avec des destinations server-side, ou si vous utilisiez des containers server-side v1 pour envoyer des données à vos partenaires, veuillez suivre les étapes suivantes !

Remplacez les appels de container par des events

Avec l'ancienne plateforme, vous aviez l'habitude d'envoyer un appel de container, avec toutes les variables. Ce n'est plus compatible. À la place, vous devez envoyer des events avec des propriétés.

Voici un exemple de code montrant comment exécuter un event :

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

Vous pouvez consulter tous les exemples de code des events ici Pour plus d'informations sur la spécificité des events, veuillez vous référer à cette page de notre documentation.

Pour la documentation technique sur l'intégration des events, veuillez visiter notre GitHub : https://github.com/CommandersAct/iOSV5/tree/master/TCServerSide#executing-events https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#executing-an-event

Mettez à jour votre data layer

La nouvelle plateforme utilise des propriétés standard, nous recommandons donc de mettre à jour le data layer de votre application mobile en utilisant nos propriétés standard autant que possible

Créez vos destinations

Vous pouvez désormais utiliser notre plateforme pour créer de nouvelles destinations et envoyer des données à vos partenaires

Test & validation

Un test Quality Assurance & validation est fortement recommandé avant le lancement en production ! Voici quelques références pour vous aider à ce sujet :

• Testing => conseils pour tester

  https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#testing

  https://github.com/CommandersAct/iosV5/tree/master/TCServerSide#testing

• Debugging => liste des méthodes pour afficher les logs dans votre app https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#debugging https://github.com/CommandersAct/iosV5/tree/master/TCServerSide#debugging

• Liste des erreurs courantes

  https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#common-errors

  https://github.com/CommandersAct/iosV5/tree/master/TCServerSide#common-errors

Votre migration est terminée !

Peut-être avez-vous des besoins spécifiques ? N'oubliez pas de consulter la FAQ suivante

FAQ

Mon data layer doit-il être identique pour mon site web et mon app ?

C'est une bonne pratique ! Nous recommandons fortement d'avoir le même data layer pour le web et l'application mobile Principal avantage : configurer une seule destination pour les deux sources ! La configuration de votre destination sera reconnue par le web et le mobile

Comment puis-je obtenir l'IDFA/AAID ?

Notre SDK ne collecte plus automatiquement l'IDFA/AAID, mais nous proposons une méthode simple pour suivre cette information :

Android ServerSideInstance.addAdvertisingIDs()); iOS [ServerSideInstance addAdvertisingIDs];

Puis-je créer des custom events ?

Oui, c'est possible !

Pour plus d'informations, consultez cette partie de notre documentation : https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#custom-events https://github.com/CommandersAct/iosV5/tree/master/TCServerSide#custom-events

Puis-je utiliser des paramètres supplémentaires ?

Oui, c'est possible ! Si vous devez envoyer plus de données que les propriétés requises, utilisez simplement la méthode "additional property", comme suit :

Exemple Android :

TCPageViewEvent pageViewEvent = new TCPageViewEvent("Consent");
pageViewEvent.pageName = "Configuration";
pageViewEvent.addAdditionalProperty("currentConsent", "refused");

Exemple iOS :

TCPageViewEvent *pageViewEvent = [[TCPageViewEvent alloc] initWithType: @"Consent"];
pageViewEvent.pageName = @"Configuration";
[pageViewEvent addAdditionalProperty: @"currentConsent" withStringValue: @"refused"];

Puis-je ajouter des variables Persisting ?

Oui, c'est possible !

Si vous devez définir une variable persistante, veuillez vous référer à cette doc : https://github.com/CommandersAct/AndroidV5/tree/master/TCServerSide#persisting-variableshttps://github.com/CommandersAct/iosV5/tree/master/TCServerSide#persisting-variables

Définition d'une persisting variable : c'est une clé/valeur qui restera la même tant que l'app est ouverte (exemple : ID de compte Google)

Dois-je modifier/mettre à jour mon fichier Json ?

Ce n'est pas nécessaire ! Votre json actuel est toujours valide pour notre nouveau SDK

Dois-je modifier/mettre à jour mes callbacks pour les statistiques de consentement ?

Ce n'est pas nécessaire ! Votre configuration actuelle est toujours valide pour notre nouveau SDK