Name	Name	Last commit message	Last commit date
parent directory ..
README.md	README.md
adobe-mobile-services-release-notes.md	adobe-mobile-services-release-notes.md
mobileservices-api-reference.md	mobileservices-api-reference.md

Adobe Analytics - Mobile Services

This extension enables in-app messaging, push notifications, and marketing links functionality from Mobile Services on the Experience Platform SDK.

{% hint style="warning" %} As of April 1, 2020, Apple will no longer support the UIWebView API. To avoid any issues, ensure that you are using the iOS SDK version 1.0.3 or later. For more information about the UIWebView API, see UIWebView . {% endhint %}

{% hint style="info" %} The Adobe Analytics Mobile Marketing Add-on SKU is required to enable Mobile Services access to mobile acquisition, deep linking, geolocation, and mobile messaging capabilities.

For more information, contact your Adobe CSM. {% endhint %}

Review the following Mobile Services functionality documentation for context and set up before implementation at these links:

{% hint style="warning" %} Postbacks created from the Mobile Services interface are not supported. Please use a Launch rule with the Mobile Core extension to create a postback. Signal extension and Rules Engine integration. {% endhint %}

{% hint style="warning" %} Before you configure the Mobile Services extension, ensure that you previously created apps in Mobile Services. To create an app in Mobile Services, see Add a new App. {% endhint %}

{% hint style="info" %} Looking for location functionality from Mobile Services? Try out Places Service, our point of interest management service. For more information, see Places Service. {% endhint %}

To use the Mobile Services extension, complete these steps:

Configure the Mobile Services extension in Launch.
If using acquisition and marketing links, update your configuration in the Analytics extension.
Add Mobile Services extension to your app.
Implement the Mobile Services APIs in your app.

Configure the Mobile Services extension in Experience Platform Launch

{% hint style="warning" %} The Mobile Services extension requires the Analytics extension for reporting and uses the report suite that is specified in the Analytics extension for reporting. However, the Mobile Services extension uses the report suite that is configured for the app in Mobile Services for push and in-app messaging, acquisition, marketing links, and app management. If the report suite in the two locations do not match, a push message from the wrong report suite might be sent. {% endhint %}

Automatic configuration (Recommended)

In Experience Platform Launch, click the Extensions tab.
Choose Catalog, locate the Adobe Analytics – Mobile Services extension, and click Install.
Select a Mobile Services app and complete the following tasks:
1. In Mobile Services app, select app from the drop-down list.
2. Click Save.
3. Follow the publishing process to update the SDK configuration.

Manual configuration

{% hint style="danger" %} The following instructions only apply if you do not see your app listed or need to manually configure your Mobile Services app. {% endhint %}

{% hint style="warning" %} If you are sending data to multiple Analytics report suites, use the Acquisition App ID from the app that is associated with the first report suite in your list of report suite IDs. {% endhint %}

To install the Mobile Services extension, complete the following steps:

Select Enter Custom settings.
Enter an Acquisition time out.
The recommended time out is 5 seconds. To enable app acquisition,

this value must be set to a value that is higher than 0.
Provide the Acquisition App ID (sample value: 0eb9f2791f0880623f91e41e5309d2ae25066e513054a4cb59168dc886b526da)).

You can find the Acquisition App ID in Mobile Services.
Select your app, navigate to Manage App Settings page, and in the SDK Acquisition Options section, copy the hashed string similar to the highlighted value:
Provide the Messages URL.
Here is a sample value: https://assets.adobedtm.com/b213432c5204bf94318f4ef0539a38b487d10368/scripts/satellite-5c7711bc64746d7f5800036e.json

You can find the Messages URL from your ADBMobileConfig.json file typically near the bottom of the file.
Click Save.
Follow the publishing process to update your SDK configuration.

Configure the Adobe Analytics extension

To ensure that this extension is correctly configured and implemented, follow the steps in the Configure the Mobile Services extension in Experience Platform Launch.
In Launch Hit Delay, type a value of 5s or more to ensure that the acquisition context is sent to Analytics with your Lifecycle information.

Add the Mobile Services extension to your app

{% hint style="info" %} The Mobile Services extension depends on the Core extension, which includes the Identity and Lifecycle frameworks and the Analytics extension. {% endhint %}

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

Java

Import the Mobile Services extension in your application's main activity.

import com.adobe.marketing.mobileservices.*;

{% endtab %}

{% tab title="iOS" %} Add the library to your project via your Podfile by adding the ACPMobileServicespod.

Objective-C

Import the library into your project:

#import "ACPCore.h"
#import “ACPIdentity.h”
#import “ACPLifecycle.h”
#import "ACPAnalytics.h"
#import "ACPMobileServices.h"

{% endtab %} {% endtabs %}

Register Mobile Services with Mobile Core

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

Java

Call the setApplication() method once in the onCreate() method of your main activity. For example, your code might look like the following:

public class MobileServicesApp extends Application {

@Override
public void onCreate() {
     super.onCreate();
     MobileCore.setApplication(this);

     try {
             Analytics.registerExtension();
MobileServices.registerExtension(); //Register Mobile Services with Mobile Core
Lifecycle.registerExtension();
             Identity.registerExtension();
             MobileCore.start(null);
     } catch (Exception e) {
     //Log the exception
     }
  }
}

{% endtab %}

{% tab title="iOS" %}

Objective C

In your app's application:didFinishLaunchingWithOptions function, register the Mobile Services extension with the Mobile Core:

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

{% endtab %} {% endtabs %}

Implement Mobile Services APIs in your app

To use your Android or iOS extension with the Experience Platform SDKs, implement the following APIs:

Set up push messaging

{% tabs %} {% tab title="Android" %} Obtain the registration ID/token by using the Firebase Cloud Messaging (FCM) APIs.

setPushIdentifier

Syntax

void setPushIdentifier(final String registrationID)

Example

MobileCore.setPushIdentifier(registrationID);

{% endtab %}

{% tab title="iOS" %} {% hint style="warning" %} iOS simulators do not support push messaging. {% endhint %}

After you complete Apple's instructions to get your app ready to handle push notifications, set the push token by using the setPushIdentifier API:

setPushIdentifier

Objective-C

Syntax

+ (void) setPushIdentifier: (nullable NSData*) deviceToken;

Example

- (void) application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
  // Set the deviceToken that the APNS has assigned to the device
  [ACPCore setPushIdentifier:deviceToken];
  //...
}

Swift

ACPCore.setPushIdentifier(deviceToken)

{% endtab %} {% endtabs %}

Debugging the push messaging set up

If everything is configured correctly, after installing your app on a mobile device, verify that the following SDK debug log is displayed:

Request to demdex.net containing device push token has been sent:

2019-01-31 18:22:35.261676-0800 DemoApp[935:156015] [AMSDK DEBUG <com.adobe.module.identity>]: Sending request (https://dpm.demdex.net/id?d_rtbd=json&d_ver=2&d_orgid=B1F855165B4C9EA50A495E06@AdobeOrg&d_mid=43583282444503123217621782542046274680&d_blob=j8Odv6LonN4r3an7LhD3WZrU1bUpAkFkkiY1ncBR96t2PTI&dcs_region=9)

Set up push tracking

Use the following API to track a push messaging click through in Adobe Analytics.

{% hint style="info" %} Using the following API does not increment page views. {% endhint %}

{% tabs %} {% tab title="Android" %} No set up required. In Android, the SDK handles push tracking to Analytics. {% endtab %}

{% tab title="iOS" %} Use the following API to track a push messaging click through in Adobe Analytics.

collectLaunchInfo

Syntax

+ (void) collectLaunchInfo:(NSDictionary *)userInfo;

Objective-C

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler {
    // only send the hit if the app is not active
    if (application.applicationState != UIApplicationStateActive) {
        [ACPCore collectLaunchInfo:userInfo];
    }
    completionHandler(UIBackgroundFetchResultNoData);
}

{% endtab %} {% endtabs %}

Troubleshooting push messaging

For more information, see the following:

Troubleshooting guide (Android)
Troubleshooting guide (iOS)

Set up in-app messaging

This feature allows you to deliver in-app messages that are triggered from any analytics data or event. After the implementation, messages are dynamically delivered to the app and do not require a code update. In-app messages are created in Mobile Services. For more information, see Create an in-app message.

To set up your app for in-app messages, implement the following instructions. You can complete these steps even if you have not yet defined any messages in Mobile Services. After you define messages, they are delivered dynamically to your app and displayed without an app store update.

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

Update the AndroidManifest.xml file to declare the full screen activity and enable the Message Notification Handler.

Java

If you are using Fullscreen message or local notification, update the AndroidManifest.xml with:

<activity
    android:name="com.adobe.marketing.mobile.MessageFullScreenActivity"
    android:windowSoftInputMode="adjustUnspecified|stateHidden" >
</activity>
<receiver android:name="com.adobe.marketing.mobile.MessageNotificationHandler" />

If you selected a modal layout, select one of the following themes for the message:

Theme.Translucent.NoTitleBar.Fullscreen
Theme.Translucent.NoTitleBar
Theme.Translucent

Example

<activity
android:name="com.adobe.marketing.mobile.MessageFullScreenActivity"
android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen"
android:windowSoftInputMode="adjustUnspecified|stateHidden" >
</activity>
<receiver android:name="com.adobe.marketing.mobile.MessageNotificationHandler" />

{% endtab %}

{% tab title="iOS" %} No setup required for iOS. SDK handles in-app message support out of the box. {% endtab %} {% endtabs %}

Fallback images

When creating a full-screen message, you can optionally specify a fallback image. If your message cannot retrieve its intended image from the web, the SDK attempts to load the image with the same name from your application’s assets folder. This allows you to show your message in its original form, even if the user is offline, or the predetermined image is unreachable.

{% hint style="warning" %} The fallback image asset name is specified when you configure the message in Mobile Services. You need to ensure that the specified resource is available. {% endhint %}

Configuring notification icons

The following methods allow you to configure the small and large icons that appear in the notification area, and the large icon that is displayed when notifications appear in the notification drawer.

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

Config.setSmallIconResourceId(int resourceId)

This API sets the small icon that is used for notifications that are created by the SDK. This icon appears in the status bar and is the secondary image that is displayed shown when the user sees the complete notification in the notification center.

Syntax

public static void setSmallIconResourceId(final int resourceId);

Example

MobileCore.setSmallIconResourceID(R.drawable.appIcon);

{% endtab %}

{% tab title="iOS" %} No setup required. Icons are automatically handled by the SDK for iOS. {% endtab %} {% endtabs %}

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

Config.setLargeIconResourceId(int resourceId)

Set the large icon that is used for notifications that are created by the SDK. This icon is the primary image that is displayed when the user sees the complete notification in the notification center.

Syntax

public static void setLargeIconResourceId(final int resourceId);

Example

MobileCore.setLargeIconResourceId(R.drawable.appIcon);

{% endtab %}

{% tab title="iOS" %} No setup required. Icons are automatically handled by the SDK for iOS. {% endtab %} {% endtabs %}

Tracking in-app messages

The SDK automatically tracks the following metrics for your in-app messages:

For full screen and alert style in-app messages:

Impressions: when user triggers an in-app message.
Click throughs: when user clicks the Click through button.
Cancels: when user clicks the Cancel button.

For custom, full screen in-app messages, the HTML content in the message needs to include the correct code to notify the SDK tracking about the following buttons:

Click-through (redirect) example tracking: adbinapp://confirm/?url=http://www.yoursite.com
Cancel (close) example tracking: adbinapp://cancel

For local (remote) notifications:

Impressions: when user triggers the notification.
Opens: when user opens app from the notification.

Here is an example about how to include open tracking:

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

- (BOOL) application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

  // handle local notification click-throughs for iOS 10 and older
  NSDictionary *localNotificationDictionary = launchOptions[UIApplicationLaunchOptionsLocalNotificationKey];
  if ([localNotificationDictionary isKindOfClass:[NSDictionary class]]) {
       [ACPCore collectLaunchInfo:localNotificationDictionary];
  }

}
- (void) application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification {
   [ACPCore collectLaunchInfo:notification.userInfo];
}

{% endtab %} {% endtabs %}

Troubleshooting in-app messaging

For more information, see the following:

Acquisition and marketing links

Acquisition and marketing links must be created in Adobe Mobile services. For more information, see Mobile Services acquisition.

{% hint style="info" %} The following set up collects Acquisition link context from links that were created in Mobile Services and collects referrer data from the Google Play store. {% endhint %}

When the user downloads and runs an app as the result of a Google Play store acquisition, the data from the referrer is collected and sent to Adobe Mobile Services. Custom keys that were part of the acquisition data from Google Play are name-spaced with a.acquisition.custom.

Using The BroadcastReceiver

Implement the BroadcastReceiver for the referrer.

package com.your.package.name;  // replace with your app package name

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;

public class GPBroadcastReceiver extends BroadcastReceiver {
  @Override
  public void onReceive(Context c, Intent i) {
      com.adobe.marketing.mobile.MobileServices.processReferrer(c, i);
  }
}

Update AndroidManifest.xml to enable the above created BroadcastReceiver

<receiver android:name="com.your.package.name.GPBroadcastReceiver" android:exported="true">
    <intent-filter>
        <action android:name="com.android.vending.INSTALL_REFERRER" />
    </intent-filter>
</receiver>

Using The Google Play Install Referrer APIs

Starting on March 1, 2020, Google is deprecating the install_referrer intent broadcast mechanism. For more information, see Still Using InstallBroadcast? Switch to the Play Referrer API by March 1, 2020 . To continue collecting install referrer information from the Google Play store, update your application to use the Mobile Services extension version 1.1.0 or newer.

With the deprecation, instead of creating a BroadcastReceiver, you need to collect the install referrer URL from a new Google API and pass the resulting URL to the SDK.

Add the Google Play Install Referrer package to your gradle file's dependencies:
```
implementation 'com.android.installreferrer:installreferrer:1.1'
```
To retrieve the referrer URL from the Install Referrer API, complete the steps in Getting the install referrer .

Pass the referrer URL to the SDK:

MobileServices.processGooglePlayInstallReferrerUrl(referrerUrl);

To decide the best way to use the Google Play Install Referrer APIs in your app, see Google's documentation. Here is an example of how to use the Adobe SDK with the Google Play Install Referrer APIs:

void handleGooglePlayReferrer() {
    // Google recommends only calling this API the first time you need it:
    // https://developer.android.com/google/play/installreferrer/library#install-referrer

    // Store a boolean in SharedPreferences to ensure we only call it once.
    final SharedPreferences prefs = getSharedPreferences("acquisition", 0);
    if (prefs != null) {
        if (prefs.getBoolean("referrerHasBeenProcessed", false)) {
            return;
        }
    }

    final InstallReferrerClient referrerClient = InstallReferrerClient.newBuilder(getApplicationContext()).build();
    referrerClient.startConnection(new InstallReferrerStateListener() {
        private boolean complete = false;

        @Override
        public void onInstallReferrerSetupFinished(int responseCode) {
            switch (responseCode) {
                case InstallReferrerClient.InstallReferrerResponse.OK:
                    // connection is established
                    complete();
                    try {
                        final ReferrerDetails details = referrerClient.getInstallReferrer();                        

                        // pass the install referrer url to the SDK
                        MobileServices.processGooglePlayInstallReferrerUrl(details.getInstallReferrer());

                    } catch (final RemoteException ex) {
                        Log.w("Acquisition - RemoteException while retrieving referrer information (%s)", ex.getLocalizedMessage() == null ? "unknown" : ex.getLocalizedMessage());
                    } finally {
                        referrerClient.endConnection();
                    }
                    break;
                case InstallReferrerClient.InstallReferrerResponse.FEATURE_NOT_SUPPORTED:
                case InstallReferrerClient.InstallReferrerResponse.SERVICE_UNAVAILABLE:
                default:
                    // API not available in the Play Store app - nothing to do here
                    complete();
                    referrerClient.endConnection();
                    break;
            }
        }

        @Override
        public void onInstallReferrerServiceDisconnected() {
            if (!complete) {
                // something went wrong trying to get a connection, try again
                referrerClient.startConnection(this);
            }
        }

        void complete() {
            complete = true;
            SharedPreferences.Editor editor = getSharedPreferences("acquisition", 0).edit();
            editor.putBoolean("referrerHasBeenProcessed", true);
            editor.apply();
        }
    });
}

{% hint style="info" %} No set up is required. Acquisition context is automatically collected and tracked by the SDK for iOS. {% endhint %}

Deep link tracking

The SDK can parse key-value pairs of data that are appended to any deep or universal link, provided the link contains a key a.deeplink.id and a corresponding non-null and user generated value. All key-value pairs of data that are appended to the URL string are parsed, attached to a lifecycle hit as context data, and sent to Adobe Analytics.

You can also append one or more of the following reserved keys, with user-generated values, to the deep or universal link:

a.launch.campaign.trackingcode
a.launch.campaign.source
a.launch.campaign.medium
a.launch.campaign.medium
a.launch.campaign.content

{% hint style="warning" %} Ensure that the deep link URL has the a.deeplink.id key in the URL string. If a.deeplink.id is not found, none of the appended URL parameters are sent to Analytics via context data. {% endhint %}

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

Java

Syntax

public static void trackAdobeDeepLink(final Uri uri)

Example

MobileServices.trackAdobeDeepLink

{% endtab %}

{% tab title="iOS" %}

trackAdobeDeepLink

Objective C

Syntax

+ (void) trackAdobeDeepLink: (NSURL* _Nonnull) deeplink;

Examples

- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url {
    [ACPMobileServices trackAdobeDeepLink:url]
    /*
     Handle deep link
     */
    return YES;
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString *, id> *)options {
    [ACPMobileServices trackAdobeDeepLink:url];
    /*
     Handle deep link
     */
    return YES;
}

{% endtab %} {% endtabs %}

Integration with Apple Search Ads (iOS)

The Adobe Experience Platform SDK leverages Apple's Search Ads attribution <> to attribute app downloads that originate from Search Ads campaigns in the Apple App Store. For more information about Search Ad campaigns, see (Apple Search Ads)[https://searchads.apple.com/]. This optional feature helps you easily measure the effectiveness of your Search Ads app download campaigns by adding a few lines of code to your app.

Implement Search Ads integration

To enable your app for Search Ad attribution, you will need to add the iAd framework (in addition to the Mobile Services extension) to your app.

Reporting on Search Ads Attribution

Apple Search Ads attribution data is provided in the acquisition name, the source, and the term values.

If attribution = true , all of the iad-* fields will be included in a Lifecycle request to Adobe Analytics. In addition, the following values will be mapped from the "iad" dictionary to our typical acquisition context data fields:

iad-campaign-id --> a.referrer.campaign.trackingcode
iad-campaign-name --> a.referrer.campaign.name
iad-adgroup-id --> a.referrer.campaign.content
iad-keyword --> a.referrer.campaign.term

This mapping ensures that the values are available in Adobe Analytics standard reporting.

Migration Notes

To prepare for your migration, remember the following information:

Lifetime value is not supported on the Experience Platform SDK, so it might not be used to trigger in-app messages or local notifications.
ce is no longer supported as a trigger for in-app messages or local notifications.
a.internalaction or action (from Lifecycle) can be used to trigger in-app messages or local notifications. We suggest using LaunchEvent instead.
Local notifications do not support Android 8.0 or higher.

Configuration keys

Key	Description
mobile.acquisitionTimeout	Amount of time, in seconds, to wait for acquisition information from the Mobile Services acquisition server.
mobile.acquisitionAppId	App ID uniquely identifies the app on the Mobile Services acquisition server.
mobile.messagesUrl	Messages URL from your configuration (`ADBMobileConfig.json`) file's remotes section.

Watch the video

{% embed url="https://youtu.be/VKI2ECZU3bU" caption="Video showing Mobile Services integration with Adobe Experience Platform Mobile SDK" %}

Additional information

Visit Mobile Services documentation
Visit Mobile Services (mobilemarketing.adobe.com)

Files

adobe-analytics-mobile-services

Directory actions

More options

Directory actions

More options

Latest commit

History

adobe-analytics-mobile-services

Folders and files

parent directory

README.md

Adobe Analytics - Mobile Services

Configure the Mobile Services extension in Experience Platform Launch

Automatic configuration (Recommended)

Manual configuration

Configure the Adobe Analytics extension

Add the Mobile Services extension to your app

Java

Objective-C

Register Mobile Services with Mobile Core

Java

Objective C

Implement Mobile Services APIs in your app

Set up push messaging

setPushIdentifier

Syntax

Example

setPushIdentifier

Objective-C

Syntax

Example

Swift

Debugging the push messaging set up

Set up push tracking

collectLaunchInfo

Syntax

Objective-C

Troubleshooting push messaging

Set up in-app messaging

Java

Example

Fallback images

Configuring notification icons

Config.setSmallIconResourceId(int resourceId)

Syntax

Example

Config.setLargeIconResourceId(int resourceId)

Syntax

Example

Tracking in-app messages

Troubleshooting in-app messaging

Acquisition and marketing links

Using The BroadcastReceiver

Using The Google Play Install Referrer APIs

Deep link tracking

Java

Syntax

Example

trackAdobeDeepLink

Objective C

Syntax

Examples

Integration with Apple Search Ads (iOS)

Implement Search Ads integration

Reporting on Search Ads Attribution

Migration Notes

Configuration keys

Watch the video

Additional information