Show Menu
SUJETS×

Méthodes de configuration

Liste des méthodes fournies par la bibliothèque Android.

Configuration initiale

La méthode suivante doit être appelée une fois dans la méthode onCreate de l’activité principale :
  • setContext Voici l’exemple de code pour cette méthode :
     @Override
     public void onCreate(BundlesavedInstanceState){
       super.onCreate(savedInstanceState)
       setContentView(R.layout.main);
       Config.setContext(this.getApplicationContext());
     }
    
    

Paramètres du SDK (Classe de configuration)

  • registerAdobeDataCallback
    • Enregistre un objet qui implémente l’interface AdobeDataCallback . La méthode « call » remplacée est appelée avec une valeur Config.MobileDataEvent et les données associées dans Map<String, Object> pour l’événement de déclenchement. Pour plus d’informations sur les événements qui déclencheront ce rappel, voir MobileDataEventEnum en bas de cette rubrique.
      Cette méthode requiert la version 4.9.0 ou supérieure.
    • Voici la syntaxe de cette méthode :
      public static void registerAdobeDataCallback(final AdobeDataCallback&amp;nbsp;callback);
      
      
    • Voici l’exemple de code pour cette méthode :
        Config.registerAdobeDataCallback(new Config.AdobeDataCallback() {
          @Override
          public void call(Config.MobileDataEvent event, Map<String, Object> contextData) {
              // handle each event type accordingly 
              if (event == Config.MobileDataEvent.MOBILE_EVENT_ACQUISITION_INSTALL) {
                   // do something with acquisition data found in contextData parameter
                   HashMap<String, Object> acquisitionData = new HashMap<String, Object>(contextData);
              }
          }
      });
      
      
  • getVersion
    • Renvoie la version actuelle de la bibliothèque Adobe Mobile.
    • Voici la syntaxe de cette méthode :
      public static String getVersion();
      
      
    • Voici un exemple de code pour cette méthode :
      String libraryVersion = Config.getVersion(); 
      
      
  • getPrivacyStatus
    • Renvoie la représentation d’énumération de l’état de confidentialité pour l’utilisateur actuel.
      Vous trouverez ci-dessous les valeurs de l’état de confidentialité :
      • MOBILE_PRIVACY_STATUS_OPT_IN  : les accès sont envoyés immédiatement.
      • MOBILE_PRIVACY_STATUS_OPT_OUT  : les accès sont ignorés.
      • MOBILE_PRIVACY_STATUS_UNKNOWN  : si la suite de rapports prend en charge l’horodatage, les accès sont enregistrés jusqu’à ce que l’état de confidentialité devienne « inclusion » (les accès sont envoyés) ou « exclusion » (les accès sont ignorés).
        Sinon, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur « inclusion ». La valeur par défaut est définie dans le fichier ADBMobileConfig.json .
    • Voici la syntaxe de cette méthode :
      public static MobilePrivacyStatus getPrivacyStatus(); 
      
      
    • Voici un exemple de code pour cette méthode :
      MobilePrivacyStatus privacyStatus Config.getPrivacyStatus();
      
      
  • setPrivacyStatus
    • Définit l’état de confidentialité pour l’utilisateur actuel sur status .
      Vous pouvez définir l’état de confidentialité sur l’une des valeurs suivantes :
      • MOBILE_PRIVACY_STATUS_OPT_IN  : les accès sont envoyés immédiatement. Ces accès sont envoyés immédiatement.
      • MOBILE_PRIVACY_STATUS_OPT_OUT  : les accès sont ignorés. Ces accès sont ignorés.
      • MOBILE_PRIVACY_STATUS_UNKNOWN  : si la suite de rapports prend en charge l’horodatage, les accès sont enregistrés jusqu’à ce que l’état de confidentialité devienne « inclusion » (les accès sont envoyés) ou « exclusion » (les accès sont ignorés). Sinon, les accès sont ignorés jusqu’à ce que l’état de confidentialité soit défini sur « inclusion ».
    • Voici la syntaxe de cette méthode :
      public static void setPrivacyStatus(MobilePrivacyStatus status); 
      
      
    • Voici un exemple de code pour cette méthode :
      Config.setPrivacyStatus(MobilePrivacyStatus.MOBILE_PRIVACY_STATUS_OPT_IN); 
      
      
  • getLifetimeValue
    • Renvoie la valeur du cycle de vie de l’utilisateur actuel. La valeur par défaut est 0 .
    • Voici la syntaxe de cette méthode :
      public static BigDecimal getLifetimeValue();
      
      
    • Voici un exemple de code pour cette méthode :
      BigDecimal currentLifetimeValue Config.getLifetimeValue(); 
      
      
  • getUserIdentifier
    • Si un identifiant personnalisé a été défini, l’identifiant de l’utilisateur personnalisé est renvoyé. Si aucun identifiant personnalisé n’a été défini, la valeur null est renvoyée. La valeur par défaut est null .
      Si votre application est mise à niveau du SDK Experience Cloud 3.x vers 4.x, l’identifiant visiteur précédent (personnalisé ou généré automatiquement) est récupéré et stocké en tant qu’identifiant utilisateur personnalisé. Ceci permet de conserver les données visiteur entre les différentes mises à niveau du SDK. Pour les nouvelles installations sur le SDK 4.x, l’identifiant de l’utilisateur est null jusqu’à ce qu’il soit défini.
    • Voici la syntaxe de cette méthode :
      public static String&amp getUserIdentifier();
      
      
    • Voici l’exemple de code pour cette méthode :
      String userId = Config.getUserIdentifier();
      
      
  • setUserIdentifier
    • Définit l’identifiant d’utilisateur sur identifier .
    • Voici la syntaxe de cette méthode :
      public static void setUserIdentifer(String identifier);
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.setUserIdentifier("billybob"); 
      
      
  • getDebugLogging
    • Renvoie la préférence de consignation de débogage actuelle. La valeur par défaut est false .
    • Voici la syntaxe de cette méthode :
      public static Boolean getDebugLogging(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Boolean debugging = Config.getDebugLogging(); 
      
      
  • setDebugLogging
    • Définit la préférence de journalisation de débogage sur debugLogging .
    • Voici la syntaxe de cette méthode :
      public static void setDebugLogging(Boolea debugLogging);
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.setDebugLogging(true);
      
      
  • collectLifecycleData
    • Indique au SDK que les données du cycle de vie doivent être collectées pour être utilisées à l’échelle de toutes les solutions dans le SDK. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void collectLifecycleData(final Activity activity,final Map<String, Object>contextData); 
      
      
    • Voici l’exemple de code pour cette méthode :
      @Override
      protectedvoid  onResume()  {
        super.onResume();
        Config.collectLifecycleData(this);
        } 
      
      
      Avec données contextuelles supplémentaires :
      @Override
      public  void  onResume()  {
        HashMap<String, Object> contextData = new HashMap<String, Object>();
        contextData.put("myapp.category", "Game");        Config.collectLifecycleData(this, contextData);} 
      
      
  • collectLifecycleData (Activity activity)
    • ( Version 4.2 ou supérieure ) Indique au SDK que les données du cycle de vie doivent être collectées pour être utilisées à l’échelle de toutes les solutions dans le SDK. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void collectLifecycleData(final Activity activity);
      
      
    • Voici l’exemple de code pour cette méthode :
      @Overrideprotected void onResume() {
        super.onResume()
        // assume being called in an Activity class Config.collectLifecycleData(this);
        } 
      
      
  • pauseCollecting​LifecycleData
    • Indique au SDK que l’application est suspendue, de sorte que les mesures de cycle de vie sont correctement calculées. Par exemple, onPause collecte un horodatage afin de déterminer la durée de la session précédente. Ceci définit également un indicateur de sorte que le cycle de vie sache que l’application n’a pas planté. Pour en savoir plus, voir la section Mesures de cycle de vie .
    • Voici la syntaxe de cette méthode :
      public static void pauseCollectingLifecycleData(); 
      
      
    • Voici l’exemple de code pour cette méthode :
      @Override
      protected void onPause() {
        super.onPause();
        Config.pauseCollectingLifecycleData();
      } 
      
      
  • setSmallIconResourceId(int resourceId)
    • ( Version 4.2 ou supérieure ) Définit la petite icône qui sera utilisée pour les notifications créées par le SDK. Cette icône apparaît dans la barre d’état et sera l’image secondaire qui s’affiche lorsque l’utilisateur voit l’ensemble de la notification dans le Centre de notifications.
    • Voici la syntaxe de cette méthode :
      public static void setSmallIconResourceId(final int resourceId); 
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.setSmallIconResourceId(R.drawable.appIcon);
      
      
  • setLargeIconResourceId(int resourceId)
    • ( Version 4.2 ou supérieure ) Définit la grande icône qui sera utilisée pour les notifications créées par le SDK. Cette icône sera l’image principale affichée lorsque l’utilisateur voit l’ensemble de la notification dans le Centre de notifications.
    • Voici la syntaxe de cette méthode :
      public static void setLargeIconResourceId(final int  resourceId);
      
      
    • Voici l’exemple de code pour cette méthode :
      Config.setLargeIconResourceId(R.drawable.appIcon);
      
      
  • overrideConfigStream(InputStream configInput)
    • ( Version 4.2 ou supérieure ) Permet de charger un fichier de configuration JSON ADBMobile distinct au démarrage de l’application. Cette autre configuration est utilisée jusqu’à la fermeture de l’application.
    • Voici la syntaxe de cette méthode :
      public static void overrideConfigStream(final InputStream configInput);
      
      
    • Voici l’exemple de code pour cette méthode :
       try {
          InputStream configInput = getAssets().open("ExampleJSONFile.json") 
          Config.overrideConfigStream(configInput)
          } catch (IOException ex) { 
          //do something with the exception if needed
      }
      
      
  • setPushIdentifier
    • Définit le jeton d’appareil pour les notifications Push.
    • Voici la syntaxe de cette méthode :
      public static void setPushIdentifier(final String registrationId); 
      
      
    • Voici l’exemple de code pour cette méthode :
      ...// note the code to retreive the push token must run in the background
      InstanceID instanceID= InstanceID.getInstance(getApplicationContext());String token=instanceID.getToken("835015092242", GoogleCloudMessaging.INSTANCE_ID_SCOPE null);Config.setPushIdentifier(token);
      ...
      
      
  • submitAdvertisingIdentifierTask
    • Fournit un joignable au SDK qui renvoie la chaîne de l’identifiant de publicité renvoyé par les services Google Play. Le SDK exécute cette tâche sur un fil en arrière-plan et définit une variable interne pour l’identifiant de publicité qui est basée sur la valeur renvoyée depuis le joignable.
      Si vous voulez utiliser l’identifiant de publicité dans l’acquisition ou le cycle de vie, vous devez l’appeler avant d’appeler Config.collectLifecycleData .
      • Voici la syntaxe de cette méthode :
        public static void submitAdvertisingIdentifierTask(final Callable<String> task); 
        
        
      • Voici l’exemple de code pour cette méthode :
        @Override
        public void  onResume() {
            super.onResume();
            final  Callable<String>; task = new Callable<String>(){
                @Override
                public String call() throws Exception {
                   AdvertisingIdClient.Info idInfo;
                   String adid = null;
                   Context appContext = CLASSNAME.this.getApplicationContext();
                   try {
                        idInfo = AdvertisingIdClient.getAdvertisingIdInfo(appContext);
                        if (idInfo != null) { 
                            adid = idInfo.getId();
                        } 
                   } catch  (Exception ex) {
                       Log.e("Error",  ex.getLocalizedMessage());
                   }
                   return  adid;
                }
          };
          Config.submitAdvertisingIdentifierTask(task); 
          Config.collectLifecycleData(this);
        }
        
        

Interface AdobeDataCallback

public interface AdobeDataCallback {  
    void call(MobileDataEvent event, Map<String, Object> contextData);  
} 

MobileDataEvent Enum

public enum MobileDataEvent {  
    MobileDataEvent.MOBILE_EVENT_LIFECYCLE, // triggers on a lifecycle hit  
    MobileDataEvent.MOBILE_EVENT_ACQUISITION_INSTALL, // triggers on a app install that has acquisition data  
    MobileDataEvent.MOBILE_EVENT_ACQUISITION_LAUNCH // triggers on launch when the device previously installed via acquisition  
}