Skip to content

README.md

Latest commit

 

History

History
249 lines (186 loc) · 10.4 KB

README.md

File metadata and controls

249 lines (186 loc) · 10.4 KB

Adobe Analytics

Configure Analytics Extension in Launch

  1. In Launch, click the Extensions tab.
  2. On the Catalog tab, locate the Adobe Analytics extension and click Install.
  3. Provide extension settings (see Configure Analytics Extension)
  4. Click Save.
  5. Follow the publishing process, to update SDK configuration

Configure Analytics Extension

Adobe Analytics Extension Configuration

Report Suites

{% hint style="info" %} How to find report suite IDs? See Report Suites. {% endhint %}

Provide one or more report suite identifiers to which the Analytics data should be sent. Multiple report suite IDs should be comma-separated with no space between. For example: rsid1,rsid2.

Tracking Server

{% hint style="info" %} What's a tracking server and where to find it? See populating Tracking Servers. {% endhint %}

Provide the tracking domain to which all Analytics requests should be made.

Offline Enabled

{% hint style="info" %} Do you need offline tracking? See Offline Tracking. {% endhint %}

When checked, Analytics hits are queued while the device is offline and sent later when the device is online. Your report suite must be timestamp-enabled to use offline tracking.

{% hint style="danger" %} If your report suite is timestamp enabled, this setting must be checked. If not, this setting must remain unchecked. If this setting is not configured correctly, data will be lost. If you're not sure that your report suite is timestamp enabled, contact Customer Care**.** {% endhint %}

{% hint style="info" %} If you currently send mobile SDK data to a report suite that also collects data from web JavaScript, you might need to set up a separate report suite for mobile data or include a custom timestamp on all JavaScript hits that use thes.timestampvariable. Please contact Customer Care for more information. {% endhint %}

Audience Manager Forwarding

{% hint style="info" %} Learn more about Analytics sever-side forwarding to Audience Manager. {% endhint %}

If you set up Analytics server-side forwarding to Audience Manager, check this setting. When this setting is enabled, all SDK requests to Analytics servers are sent with an expected response code of 10. This step ensures ****Analytics traffic is forwarded to Audience Manager and that the Audience Manager User Profile is correctly updated in the SDK.

Backdate Previous Session Info

{% hint style="warning" %} Enable this setting only with report suite(s) that are timestamp enabled. {% endhint %}

Enabling this setting will cause the SDK to backdate end-of-session lifecycle information so it can be attributed into its correct session. Session information currently consist of crashes and session length.

When enabled, the SDK will backdate the session information hit to 1 second after the last hit of the previous session. This means that crashes and session data will correlate with the correct date in which they happened. One hit will be backdated on every new launch of the application.

For instance, if this setting is checked, Lifecycle session information or crash events will be backdated to one second after the last hit was sent. If unchecked, Lifecycle data will be attached to the first hit of the subsequent session.

When disabled, the Adobe SDK will attach the session info to the current lifecycle.

Batch Limit

This setting creates a threshold number of hits to be sent in consecutive calls. For example, this setting is set to 10, each Analytics hit before the 10th hit will be stored in the queue. When the 10th hit comes in, all 10 hits will be sent to Analytics, consecutively.

{% hint style="info" %} If you're batching hits (that is, you're setting a value greater than 0) then ensure that Offline Enabled is also checked. {% endhint %}

The default value for this setting is 0, which means that hit batching is disabled and all hits will be immediately sent to Analytics as they are generated.

Add Analytics to your app

{% tabs %} {% tab title="Android" %} Add the Analytics extension to your project using the app's Gradle file.

Java

  1. Import the Analytics extension in your application's main activity.
import com.adobe.marketing.mobile.*;

{% endtab %}

{% tab title="iOS" %} Add the library to your project via your Cocoapods Podfile by adding pod 'ACPAnalytics'

Objective-C

#import <ACPAnalytics_iOS/ACPAnalytics_iOS.h>

Swift

import ACPAnalytics_iOS

{% endtab %} {% endtabs %}

Register Analytics with Mobile Core

{% tabs %} {% tab title="Android" %}

Java

You may do the following after calling the setApplication() method in the onCreate() method. Here is code sample which calls these setup methods:

public class MobileApp extends Application {
​
 @Override
 public void onCreate() {
     super.onCreate();
     MobileCore.setApplication(this);
​
     try {
         Analytics.registerExtension(); //Register Analytics with Mobile Core
         Identity.registerExtension();
     } catch (Exception e) {
         //Log the exception
     }
 }
}

{% endtab %}

{% tab title="iOS" %} In your app'sapplication:didFinishLaunchingWithOptions, register Analytics with Mobile Core:

Objective-C

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPAnalytics registerExtension];
  // Override point for customization after application launch.
  return YES;
 }

Swift

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
 ACPAnalytics.registerExtension();
 // Override point for customization after application launch. 
 return true;
}

{% endtab %} {% endtabs %}

Send Lifecycle Metrics to Analytics

In order to automatically report on the application lifecycle details in Analytics, you need to properly configure the lifecycle data collection. For more detail, see Lifecycle Metrics.

Send app states and actions to Analytics

To track mobile app states and actions in Adobe Analytics, implement the track app actions and track app states APIs from the Mobile Core.

{% hint style="info" %} trackState API will report the View State as Page Name, and state views are reported as Page View in Analytics. {% endhint %}

{% hint style="info" %} trackAction API will report the Action as an event, and will not increment your page views in Analytics. {% endhint %}

Integrations with Experience Cloud solutions and services

Analytics for Target (A4T)

To see the performance of your Target activities for certain segments you can set up the Analytics for Target (A4T) cross-solution integration by enabling the A4T campaigns. This integration allows you to use Analytics reports to examine your results. If you use Analytics as the reporting source for an activity, all reporting and segmentation for that activity is based on Analytics data collection. For more information, see Target.

Server-side forwarding with Audience Manager

If you want to share the Analytics Data with Adobe Audience Manager, you can enable this in Launch UI in the Analytics extension, by selecting “Audience Manager Forwarding” option and installing the Audience Manager extension. For more details, please consult the Audience Manager section.

Video Analytics

For more information on collecting video analytics, see Heartbeat Video Measurement.

Configuration Keys

If you need to update SDK configuration, programmatically, please use the following information to change your Analytics configuration values. For more information, Configuration Methods Reference.

Key Required Description
analytics.server Yes See Tracking Server
analytics.rsids Yes

See Report Suites

Multiple report suite IDs may be comma-separated with no space in- between. For example:
"rsids" : "rsid" "rsids" : "rsid1,rsid2"

analytics.batchLimit No See Batch Limit
analytics.aamForwardingEnabled No See Audience Manager Forwarding
analytics.offlineEnabled No See Offline Enabled
analytics.backdatePreviousSessionInfo No See Backdate Previous Session Info.