Méthodes Analytics

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

Le SDK prend actuellement en charge plusieurs solutions Adobe Experience Cloud, notamment Analytics, Target, Audience Manager, ainsi que le service d’identification Adobe Experience Platform. Un préfixe est attribué aux méthodes selon la solution. Par exemple, les méthodes d’Experience Cloud ID sont affectées du préfixe analytics.

Chacune des méthodes suivantes est utilisée pour envoyer des données vers la suite de rapports Adobe Analytics :

• trackState

  Contrôle l’état d’une application avec les données contextuelles facultatives. Les états sont les affichages disponibles dans l’application, par exemple home dashboard, app settings, cart, etc. Ces états sont semblables aux pages d’un site web ; les appels trackState incrémentent les pages vues.

  Si state est vide, app name app version (build) s’affiche dans les rapports. Si cette valeur s’affiche dans les rapports, assurez-vous que vous avez défini state dans chaque appel trackState.

  CONSEIL

  Il s’agit du seul appel de suivi qui incrémente les pages vues.

  • Voici la syntaxe de cette méthode :

    public static void trackState(String state, Map<String, Object> contextData);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackState("loginScreen", null);
    

• trackAction
  Effectue le suivi d’une action dans votre application.

  Actions que vous voulez mesurer, par exemple logons, banner taps, feed subscriptions, et d’autres mesures, qui se produisent dans l’application.

  • Voici la syntaxe de cette méthode :

    public static void trackAction(String state, Map<String, Object> contextData);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackAction("heroBannerTouched", null);
    

• getTrackingIdentifier
  envoie l’identifiant visiteur automatiquement généré pour Analytics.

  Il s’agit d’un ID de visiteur unique spécifique à l’application, qui est généré au lancement initial et qui est stocké et utilisé à partir de ce moment. L’identifiant est conservé entre les mises à niveau de l’application et supprimé lorsque l’application est désinstallée.

  • Voici la syntaxe de cette méthode :

    public static String getTrackingIdentifier();
    

  • Voici l’exemple de code pour cette méthode :

    String trackingId = Analytics.getTrackingIdentifier();
    

• trackLocation

  Envoie la latitude, la longitude et la position actuelles dans un point ciblé défini. Pour plus d’informations, voir Géolocalisation et points ciblés.

  • Voici la syntaxe de cette méthode :

    public static void trackLocation(Location location, Map<String, Object> contextData);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackLocation(userLocation, null);
    

• trackLifetime​ValueIncrease

  Ajoute amount à la valeur de durée de vie de l’utilisateur.

  • Voici la syntaxe de cette méthode :

    public static void trackLifetimeValueIncrease(BigDecimal amount, Map<String, Object> contextData);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackLifetimeValueIncrease(new BigDecimal(30), null);
    

• trackTimed​ActionStart

  Commence une minutée portant le nom action action.

  Si vous appelez cette méthode pour une action qui a déjà commencé, l’action minutée précédente est écrasée.

  CONSEIL

  Cet appel n’envoie pas d’accès.

  • Voici la syntaxe de cette méthode :

  public static void trackTimedActionStart(String action, Map<String, Object> contextData);
  

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackTimedActionStart("cartToCheckout", null)
    

• trackTimed​ActionUpdate

  Transmet contextData pour mettre à jour les données contextuelles associées à l’action. Les données data transmises sont ajoutées aux données existantes pour l’action et, si la même clé est déjà définie pour action, écrase les données.

  CONSEIL

  Cet appel n’envoie pas d’accès.

  • Voici la syntaxe de cette méthode :

    public static void trackTimedActionUpdate(String action, Map<String, Object> contextData);
    

  • Voici un exemple de code pour cette méthode :

    HashMap cdata = new HashMap<String Object> ();
    cdata.put("quantity",3);
    Analytics.trackTimedActionUpdate("cartToCheckout", cdata);
    

• trackTimed​ActionEnd

  Termine une action minutée. Si vous fournissez block, vous pouvez accéder aux valeurs temporelles finales et manipuler data avant d’envoyer l’accès final.

  CONSEIL

  Si vous fournissez un block, vous devez renvoyer true (OUI) pour envoyer un accès. La transmission de null pour block envoie l’accès final.

  • Voici la syntaxe de cette méthode :

    public static void trackTimedActionEnd(String action, TimedActionBlock<Boolean> logic);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.trackTimedActionEnd("cartToCheckout",new
    Analytics.TimedActionBlock<Boolean>(){
        @Override
        public Boolean call(long inAppDuration, long totalDuration, Map<String, Object> contextData) {
            contextData.put("price", 49.95);
            return true;
        }
    });
    

• sendQueuedHits

  Requiert le SDK 4.1.

  Quel que soit le nombre d’accès mis en file d’attente, cette méthode force la bibliothèque à envoyer tous les accès dans la file d’attente hors ligne.

  • Voici la syntaxe de cette méthode :

    public static void sendQueuedHits();
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.sendQueuedHits();
    

• getQueueSize

  Renvoie le nombre d’appels de suivi stockés dans la file d’attente hors ligne.

  • Voici la syntaxe de cette méthode :

    public static long getQueueSize();
    

  • Voici l’exemple de code pour cette méthode :

    long queueSize = Analytics.getQueueSize();
    

• clearQueue

  Efface tous les accès de la file d’attente hors ligne.

  • Voici la syntaxe de cette méthode :

    public static void clearQueue();
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.clearQueue();
    

    AVERTISSEMENT

    Soyez prudent lorsque vous effacez manuellement la file d’attente. Cette action est irréversible.

• processReferrer

  Traite les données de campagne des référents de la boutique Google Play pour une utilisation ultérieure.

  • Voici la syntaxe de cette méthode :

    public static void processReferrer(final Context context, final Intent intent);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.processReferrer(getApplicationContext(), intent);
    

• processGooglePlayInstallReferrerUrl

  IMPORTANT

  Cette API est disponible à partir de la version 4.18.0 du SDK.

  Récupère les données d’acquisition à partir de l’URL du référent d’installation Google Play fournie.

  Les données collectées à partir de cette API seront envoyées lors des accès d’installation envoyés à Analytics et seront disponibles dans le rappel de données Adobe.

  Si les données du référent ont déjà été collectées par le SDK, l’appel de cette méthode n’aboutira pas.

  Pour plus d’informations sur la récupération de l’URL du référent, consultez la documentation Google : https://developer.android.com/google/play/installreferrer/library (documentation en anglais).

  • Voici la syntaxe de cette méthode :

    public static void processGooglePlayInstallReferrerUrl(final String referrerUrl);
    

  • Voici l’exemple de code pour cette méthode :

    Analytics.processGooglePlayInstallReferrerUrl(referrerUrl);