Configuration

 

Avant-propos

Afin de faciliter l’intégration de votre marqueur, l’application Tag Composer vous permet de configurer et télécharger notre SDK.

Ces variables de configuration sont écrites dans le fichier defaultConfiguration.json du tracker.

Nous recommandons l’utilisation de la configuration secure à true, l’OS pouvant bloquer les requêtes non sécurisées.

 

Modification de la configuration

Vous pouvez modifier à tout moment la configuration de votre marqueur.

Lors de la création d’un tracker :

Tracker mySpecificTracker = ATInternet.getInstance().getTracker("mySpecificTracker", new HashMap<String, Object>() {{
            put("log","YOURLOG");
            put("logSSL", "YOURSSLLOG");
            put("domain", "YOURDOMAINLOG");
            put("pixelPath", "/hit.xiti");
            put("site", YOURSITEID);
            put("secure", true);
            put("identifier", "androidId");
            put("enableCrashDetection", true);
            put("plugins", "tvtracking");
            put("storage", "required");
            put("hashUserId", false);
            put("persistIdentifiedVisitor", true);
            put("campaignLastPersistence", false);
            put("campaignLifetime", 30);
            put("sessionBackgroundDuration", 60);
        }});

Via l’utilisation de la méthode setConfig du tracker :

Attention, la méthode setConfig est une méthode asynchrone. Pour vous assurer que la configuration a bien été appliquée, un callback vous indique que la configuration est prise en compte.

  1. Modification d’une clé de configuration
    tracker.setConfig("secure", true, new SetConfigCallback() {
          @Override
          public void setConfigEnd() {
              Log.d(null, "Tracker is now using SSL");
          }
    });
  2. Remplacement de certaines clés de configuration :

    Seules les clés passées en paramètre seront modifiées ou ajoutées dans la configuration existante

    HashMap config = new HashMap<String, Object>() {{
                put("site", YOURSITEID);
                put("secure", true);
                put("identifier", "androidId");
            }};
    
    tracker.setConfig(config, false, new SetConfigCallback() {
           @Override
           public void setConfigEnd() {
               Log.d(null, "Configuration is now set");
           }
    });
  3. Changement complet d’une configuration :

    Les clés existantes seront supprimées et remplacées par les nouvelles clés passées en paramètre

    HashMap config = new HashMap<String, Object>() {{
                put("log", "YOURLOG");
                put("logSSL", "YOURSSLLOG");
                put("site", YOURSITEID);
                put("secure", true);
                put("hashUserId", false);
                put("storage", "required");
                put("pixelPath", "/hit.xiti");
                put("plugins", "tvtracking");
                put("domain", "YOURDOMAINLOG");
                put("identifier", "androidId");
                put("persistIdentifiedVisitor", true);
                put("enableCrashDetection", true);
                put("campaignLastPersistence", true);
                put("campaignLifetime", 1);
                put("sessionBackgroundDuration", 10);
            }};
    
    tracker.setConfig(config, true, new SetConfigCallback() {
         @Override
         public void setConfigEnd() {
             Log.d(null, "Configuration is now set");
         }
    });

Depuis la version 2.2.0, il est désormais possible d’utiliser des helpers et des constantes afin de simplifier la gestion de la configuration.

  1. Exemple d’utilisation des helpers
    // Log
    ATInternet.getInstance().getDefaultTracker().setLog("YOURLOG", new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new log is set");
                }
            });
    
    // Secured log
    ATInternet.getInstance().getDefaultTracker().setSecuredLog("YOURSSLLOG", new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new secured log is set");
                }
            });
    
    // Site id
    ATInternet.getInstance().getDefaultTracker().setSiteId(YOURSITEID, new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new site id is set");
                }
            });
  2. Exemples d’utilisation des constantes (toutes les constantes sont disponibles dans la classe TrackerConfigurationKeys)
    // Log
    ATInternet.getInstance().getDefaultTracker().setConfig(TrackerConfigurationKeys.LOG, "YOURLOG", new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new log is set");
                }
            });
    
    // Secured log
    ATInternet.getInstance().getDefaultTracker().setConfig(TrackerConfigurationKeys.LOG_SSL, "YOURSSLLOG", new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new secured log is set");
                }
            });
    
    // Site id
    ATInternet.getInstance().getDefaultTracker().setConfig(TrackerConfigurationKeys.SITE, YOURSITEID, new SetConfigCallback() {
                @Override
                public void setConfigEnd() {
                    Log.d("TAG", "Your new site id is set");
                }
            });
 

Liste des variables

NomValeur par défautDescription
logDéfinit le log de collecte des hits
logSSLDéfinit le log de collecte sécurisé des hits
domainxiti.comDéfinit le domaine du log de collecte
pixelPath/hit.xitiChemin pour le pixel de confirmation d’envoi
siteDéfinit l’identifiant du site
securefalseActive l’utilisation du mode SSL
identifierandroidIdDéfinit le type d’identifiant utilisateur (androidId, advertisingId,UUID)
storageneverDéfinit le mode de stockage des hits (required, never, always)
enableCrashDetectiontrueActive la récupération des informations de crash de l’application
hashUserIdfalseActive le hashage de l’identifiant utilisateur (sha256)
persistIdentifiedVisitortrueActive le stockage des informations de visiteur identifié (numérique ou texte)
pluginsActive un ou plusieurs plugins (e.g : tvtracking,nuggad). Les plugins sont séparés par des virgules
campaignLifetime30Définit la durée de vie d’une campagne (par défaut : 30 jours)
campaignLastPersistencefalseDéfinit le mode de rémanence (par défaut, la première campagne détectée sera considérée comme campagne rémanente)
sessionBackgroundDuration60Définit la durée en secondes entre deux sessions une fois que l’application est passée en arrière-plan
ignoreLimitedAdTrackingtruePermet de prendre en compte la configuration OS de suivi publicitaire limité : les hits seront considérés comme opt-out (true), sinon un GUID sera utilisé pour l’identification utilisateur (false). Depuis v2.11.2
sendHitWhenOptOuttruePermet l’envoi de hits anonymisés lorsque l’utilisateur est en « opt-out ». Depuis v2.12.0
 

Cet article vous a-t-il été utile ?

Dernière mise à jour : 28/05/2019