[DEPRECATED] Configuring a mobile application using SDK V4

[DEPRECATED] Configuring a mobile application using SDK V4

Search
Campaign User Guide

On this page

Applies to: Campaign

某些 Creative Cloud 应用程序、服务和功能在中国不可用。

Discover how to configure Adobe Campaign to send push notifications using SDK V4.

Caution:

The Mobile version 4 SDKs is deprecated and support will end on August 31, 2021.
. 

We recommend migrating to the new Experience Platform Mobile SDK. For more on this, refer to this page.

Push notification is supported by SDK V4 and Adobe Experience Platform SDKs unlike In-App. For more information on how to use In-App with your mobile app, refer to this page.

The mobile applications receiving push notifications must be configured by an administrator in the Adobe Campaign interface.

By configuring both Adobe Campaign and Adobe Mobile Services, you will be able to use your mobile application's data for your campaigns.

Push notification implementation has to be performed by expert users. If you need to be assisted, contact your Adobe Account executive or Professional services partner.

As an expert user, to configure mobile applications in Adobe Campaign, refer to the following technotes:

Note:

This document details the process for integrating your mobile application with Adobe Campaign. It does not provide information on how to create the mobile application or how to configure it for managing notifications. If you would like further information on this, refer to the official Apple and Android documentations.

To be able to send push notifications, you need to:

  1. Make sure you can access the Mobile app channel in Adobe Campaign.

  2. Configure your mobile application in:

  3. Perform the mobile application's specific setup:

    • Package the configuration file downloaded from the Adobe Mobile Services interface with the mobile application.

    • Integrate the Experience Cloud Mobile SDK into your mobile application. See Integrating the SDK into a mobile application.

  4. Define the data that you want to collect from your application's subscribers. The mobile application's subscribers who have a profile in the Adobe Campaign database are reconciled based on the criteria that you defined.

    See Collecting subscribers' data from a mobile application.

  5. Make sure that the setup has been completed successfully by launching your mobile application on your device and signing in. Make sure you opt in to receive notifications.

  6. Then, in Adobe Campaign's advanced menu, select Administration > Channels > Mobile app.

  7. Select your mobile application from the list to display its properties. Your subscription information is displayed under the subscribers list.

    push_notif_mobile_app

  8. To check the mobile applications a profile has subscribed to, in the Profiles & Audiences > Profiles menu, select a profile and click the Edit profile properties button on the right. The mobile applications are listed in the Mobile App Subscriptions tab.

    push_notif_subscriptions

You can now send push notifications to your recipients.

Setting up a mobile application in Adobe Campaign

To be able to send push notifications with Adobe Campaign, you must configure the mobile application that will receive them.

  1. Click the Adobe Campaign logo, in the top left corner, then select Administration > Channels > Mobile app (SDK V4).

  2. Click Create to set up an application.

  3. Enter a name.

  4. In the Device-specific settings section of a mobile application dashboard, for each device, you need to provide the application details:

    • iOS Certificate: drag and drop your iOS Certificate file or select it from your computer. For more information on certificates for iOS, refer to this page.
    • Android Server key: enter your Android Server key in the field. To know where to find your server key, refer to this page.

    Once your certificate is uploaded, a message will let you know if the upload was successful.

    Note that after successfully adding the certificate in Adobe Campaign Standard, you will no longer be able to change your settings back since only one APNS platform (production or sandbox) can be added to the MCPNS app.

    Note:

    For iOS devices, you can create an application that uses the sandbox mode for tests and approvals. For more on this, refer to the documentation on the Apple notifications service.

    Certificate successful

  5. Click Create.

    push_notif_created_mobile_app

In the Mobile application properties section, two URLs are listed: Collect PII Endpoint and Campaign Tracking Endpoint. They will be used in the Adobe Mobile Services interface. See Configuring a mobile application in Adobe Mobile Services.

  • The Collect PII endpoint URL is used to collect the users' Experience Cloud IDs and registration tokens from the mobile application when it is launched. When a user logs into the application using credentials such as email, first name, last name etc., this data is also collected and used to reconcile the user's registration token with an Adobe Campaign profile.
  • The Campaign Tracking Endpoint URL is used to track push notification opening.

You can now use these values in Adobe Mobile Services to finish the configuration, as explained in the Configuring a mobile application in Adobe Mobile Services section.

Configuring a mobile application in Adobe Mobile Services

To send the data collected by Adobe Mobile Services to Adobe Campaign, you must configure postbacks in the Mobile Services interface.

You will need specific information that you can find in the mobile application parameters set in Adobe Campaign (see Setting up a mobile application in Adobe Campaign):

  • IMS Organization ID
  • Collect PII Endpoint
  • Campaign Tracking Endpoint

You must have access to Adobe Analytics to do the following configuration. If you are not an Adobe Analytics user, contact your Adobe Campaign administrator.

  1. Log into mobilemarketing.adobe.com.

  2. Create the application or select an existing one.

  3. Go to the Manage App Settings page.

  4. In the Visitor ID Service section, check Enable and select your organization from the drop-down list. Click Save.

    Note:

    This organization must be the same as the one you use on the Adobe Campaign instance.

  5. Click Manage Postbacks.

  6. Create a postback.

    • Select Postback as the Postback Type.
    • In the URL field, copy the Campaign Tracking Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name. See Setting up a mobile application in Adobe Campaign.
    • Fill in the Post Body field as follows:

    For iOS:

    {
"pushPlatform":"apns",
"marketingCloudId":"{%mcid%}"
}

    For Android:

    {
"pushPlatform":"gcm",
"marketingCloudId":"{%mcid%}"
}
    • Set Content Type as application/json.
    • In the Which Data Tags Trigger the Postback?, select any event, typically Launched and does not exist.
    • Click Save & Activate.

  7. Create a second postback.

    • Select Postback as the Postback Type.
    • In the URL field, copy the Collect PII Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name. See Setting up a mobile application in Adobe Campaign.
    • Fill in the Post Body field as follows:

    For iOS:

    {
"pushPlatform":"apns",
"marketingCloudId":"{%mcid%}"
}

    For Android:    

    {
"pushPlatform":"gcm",
"marketingCloudId":"{%mcid%}"
}
    • Set Content Type as application/json.
    • In the Trigger(s) category, select any Analytics event. For example, Launched and exists. 
    trigger
    • Set Trait:

    Note:

    If you have an Android and iOS mobile application, you will need to create a separate postback for each of them. 

    For Android: Select OS version, starts with and Android.         

    f

    For iOS Select OS version, starts with and iOS. 

    d
    •  Click Save & Activate.

  8. Create a third postback.

    • Select PII as the Postback Type.
    • In the URL field, copy the Collect PII Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name. See Setting up a mobile application in Adobe Campaign.
    • Fill in the Post Body field as follows:

    For iOS:

    {
"userKey": "{userKey}",
"pushPlatform":"apns",
"marketingCloudId":"{%mcid%}",
"cusEmail":"{email}",
"cusFirstName":"{firstName}",
"cusLastName":"{lastName}"
}

    For Android:

    {
"userKey": "{userKey}",
"pushPlatform":"gcm",
"marketingCloudId":"{%mcid%}",
"cusEmail":"{email}",
"cusFirstName":"{firstName}",
"cusLastName":"{lastName}"
}
    • Set Content Type as application/json.
    • In the Trigger(s) category, select any Analytics event that you want the postback to send to Campaign. Note any data that you have included in the Post Body from the previous steps needs to be available to the SDK at the time of the triggering event.
    • Click Save & Activate.

  9. Create a postback to send push tracking data to Campaign:

    • Select Postback as the Postback Type.
    • In the URL field, copy the Campaign Tracking Endpoint URL from the mobile application that you configured in the Adobe Campaign interface, preceded by the server name.

    Note:

    Note that the postback URL passes broadlogID, deliveryID, and action to Adobe Campaign. The values for these keys need to be available to the SDK when the postback fires.

    • broadlogID and deliveryID can be obtained from the payload of the push notification.
    • action needs to be set based on the users action. See Implementing Push Tracking.

    •  Set Content Type as application/json.
    • Set Trigger as a custom event that SDK fires when the mobile application should send the tracking event. For example, if your mobile application has a custom event named “tracking,” your trigger should look like the following: 
    f
    •  Click Save & Activate.

Integrating the SDK into a mobile application

The Mobile core service’s software development kit (SDK) facilitates the integration of a mobile application into Adobe Campaign.

The SDK also enables the mobile application to:

  • Register the subscribers to Adobe Campaign.
  • Collect and send data to Adobe Campaign.
  • Track the notification clicks in Adobe Campaign.

To integrate a mobile application with the SDK:

  1. Go to Adobe Mobile Services documentation to download the Mobile core service’s SDK.

  2. Integrate the SDK with your application by following these steps:

The detailed steps are described in the Integrating the Adobe Mobile SDK with your mobile app technote.

Collecting subscribers' data from a mobile application

A specific custom resource allows you to define the data that you want to collect from your applications' subscribers.

  1. Click the Adobe Campaign logo, in the top left corner, select Administration>Development, then Custom resources in the navigation pane.

    Caution:

    Only users assigned with administration rights can extend resources. For more on this, refer to the Custom resources section.

  2. Select the Subscriptions to an application resource to extend it.

    POI_subscriptions_cusResource

  3. In the Fields section, define the customer data that you want to retrieve from your mobile applications, such as email, first name, last name, etc.

    Note:

    If you are managing several mobile applications, all fields used by all of your applications must be listed. The iOS or Android collect PII call defines which fields are captured by each application.

  4. In the Link to profiles section, set the reconciliation key used to link the profiles from the Adobe Campaign database to your applications' subscribers, such as the email.

    Note:

    You can only define one reconciliation key for all of your mobile applications.

  5. Publish the custom resource.

You are now able to collect subscribers' data in Adobe Campaign.