Configuring a mobile application using Experience Platform SDKs

Note:

Both push notifications and In-app messages are supported by Experience Platform SDKs. This feature is optional and currently a Beta feature which can be subject to future changes.

Note:

Customers leveraging SDK V4 in their Mobile Apps may require some additional configuration to enable their user base to incrementally upgrade to Experience Platform SDK-version of the App. This configuration will be provided with In-App GA release.

To send push notifications and In-App messages with an Experience Cloud SDK application, a mobile app has to be set up in Adobe Experience Platform Launch and be configured in Adobe Campaign.

To start the configuration, complete the following steps:

  1. In Adobe Campaign, ensure that you can access the following mobile channels:

    • Push notification
    • In-App message

    If you cannot access these channels, contact your account team.

  2. In Launch, create the mobile application by creating a mobile property.

    For more information, see Set up a mobile property.

  3. In Launch, click the Extensions tab, go to Catalog, and search for the Adobe Campaign Standard extension.

    For more information, see Adobe Campaign Standard (Beta).

  4. To install this extension, click Install.

  5. In Launch, configure rules for your application.

    For more information, see Configuring your application in Adobe Launch.

  6. In Adobe Campaign Standard, configure your Launch application.

    For more information, see Setting up your Adobe Launch application in Adobe Campaign.

  7. Add channel-specific configuration to your Mobile Application set up.

    For more on this refer to Channel specific application configuration in Adobe Campaign.

  8. If needed, you can later on delete your Adobe Launch property. For more on this, refer to Deleting your Adobe Launch application.

Configuring your application in Launch

In Launch, you need to create data elements and rules to send PII and other data from mobile apps to Campaign.

Caution:

To ensure that all configuration changes in Launch take effect, you must publish these changes. For more information, see Publishing.

To configure your application in Adobe Launch, follow these steps:

Step 1: Create data elements

Here are the data elements we recommend creating in Adobe Launch:

  • Experience Cloud ID, which will be mapped to Identity.Experience Cloud Id
  • Pkey, a unique key for refencing mobile application in Adobe Campaign, which will be mapped to:
    Mobile Core.State:com.adobe.module.configuration/campaign.pkey
  • Campaign server, which will be mapped to:
    Mobile Core.State:com.adobe.module.configuration/campaign.server

To create these data elements:

  1. In Launch, from your mobile application dashboard, click the Data Elements tab.

  2. To create the Experience Cloud ID data element, click Create New Data Element.

  3. Complete the following steps:

    1. In the Name field, for example, type in mcid.
    2. From the Extension drop-down, select Mobile Core.
    3. From the Data element type drop-down, select Experience Cloud ID.
    acs_create_data_element_mark-id
  4. Click Save.

  5. To create the Pkey data element, click Add Data Element.

  6. Complete the following steps:

    1. In the Name field, for example, type in pkey.
    2. From the Extension drop-down, select Mobile Core.
    3. From the Data element type drop-down, select Free Form.
    4. In Path, type the following:
      ~state.com.adobe.module.configuration/campaign.pkey

  7. Click Save.

  8. To create the Campaign server data element, click Add Data Element.

  9. Complete the following steps:

    1. Type a name, for example, camp-server.
    2. From the Extension drop-down, select Mobile Core.
    3. From the Data element type drop-down, select Free Form.
    4. In Path, type the following:
      ~state.com.adobe.module.configuration/campaign.server
  10. Click Save.

Step 2: Create rules for a PII postback

To send PII to Campaign, create a rule in Launch.

  1. In Launch, from your mobile application dashboard, click the Rules tab.

  2. Click Create New Rule.

  3. Type a name, for example, Mobile Core - Collect PII.

  4. In the Events section, click Add.

  5. Complete the following steps:

    1. From the Extension drop-down, select Mobile Core.
    2. From the Event type drop-down, select Collect PII.
  6. Click Keep changes.

  7. In the Actions section, click Add.

  8. Complete the following steps:

    1. From the Extension drop-down, select Mobile Core.
    2. From the Action type drop-down, select Send PII.
  9. In URL, enter the following URL:

    https://{%%camp-server%%}/rest/head/mobileAppV5/{%%pkey%%}/subscriptions/{%%mcid%%}
  10. Select the Add Post Body check box.

  11. In Post Body, type the following:

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

    Note:

    The userKey field is optional and enables you to reconcile your app subscribers with the recipients in the database. The pushPlatform and marketingCloudId key-value pairs are required and should not be changed or removed. The user PII starts from the eighth line and can be customized as per your requirements. However, the keys (for example cusEmail and cusFirstName) should match the field IDs that are defined in your custom resource in the Adobe Campaign Standard instance. The value variables (for example email and firstName) should match the keys in the JSON data that is sent while calling the AMS collectPII API from the app code.

  12. In Content Type, type application/json.

  13. In Timeout, select 0.

    acs_create-rule-postback-box
  14. Click Keep changes and then Save.

Your user data is now configured to be sent to Campaign.

Step 3: Create rules for In-App tracking postback

To send tracking data to Campaign for reporting on how your users interact with In-App messages in your mobile application, create the following rule in Launch:

  1. In Launch, from your mobile application dashboard, select the Rules tab.

  2. Click Add Rule.

  3. Type a name, for example, Adobe Campaign - In-App click tracking.

  4. In the Events section, click Add.

  5. Complete the following steps:

    1. From the Extension drop-down, select Adobe Campaign Standard.
    2. From the Event type drop-down, select In-App click tracking.
  6. Click Keep changes.

  7. In the Actions section, click Add.

  8. Complete the following steps:

    1. From the Extension drop-down, select Mobile Core.
    2. From the Action type drop-down, select Send postback.
  9. Add your environment URL in the URL sandbox in the following format:

    https://{%%camp-server%%}/r/?id={%%id%%}mcid={%%mcid%%}
  10. Select the Add post body check box.

  11. In Post Body, type { }.

  12. In Content Type, type application/json.

  13. In Timeout, select 0.

    acs_create_rule-inapp_track-postback1
  14. Click Keep changes and then Save.

The tracking data will now be sent to Adobe Campaign.

Step 4: Create rules for push notifications tracking postback

To send tracking data to Campaign for reporting on how your users interact with Push messages in your mobile application, create the following rule in Launch:

  1. In Launch, from your mobile application dashboard, click the Rules tab.

  2. Click Add Rule.

  3. Type a name, for example, Adobe Campaign - push click tracking.

  4. In the Events section, click Add.

  5. Complete the following steps:

    1. From the Extension drop-down, select Mobile Core.
    2. From the Event type drop-down, select Track Action.
  6. From the Action drop-down, select Action, select equals, and type tracking.

  7. Click Keep changes.

  8. In the Actions section, click Add.

  9. Complete the following steps:

    1. From the Extension drop-down, select Mobile Core.
    2. From the Action type drop-down, select Send postback.
  10. Add your environment URL in the URL sandbox in the following format:

    https://{%%camp-server%%}/r/?id={%%broadlogId%%},{%%deliveryId%%},{%%action%%}
  11. Select the Add Post Body check box, and in URL, type { }.

  12. In Content Type, type application/json.  

  13. In Timeout, select 0.

  14. Click Keep changes and then Save.

Setting up your Adobe Launch application in Adobe Campaign

To use an Launch mobile property in Campaign, you also need to configure this property in Adobe Campaign. To ensure that these properties are visible in Adobe Campaign, configur them up with the same IMS org that you used in your Adobe Campaign instance.

  1. From the advanced menu, click Administration > Channels > BETA:Mobile app (SDK V5).

    launch_1
  2. Select the mobile application you created in Adobe Launch.

    Its property status should be Ready to configure.

    launch_2
  3. To make the connection between Campaign and Adobe Launch, click Save.

  4. Verify that the status of the mobile app has changed from Ready to Configure to Configured.

    When the Adobe Launch Campaign extension shows that the pkey has been set up successfully, you can also verify that the property has been set up successfully in Campaign.

    Note:

    The pkey is a unique key that is used to reference a mobile application in Adobe Campaign.

    launch_3
  5. For this configuration to take effect, the changes need to be published in Launch.

    For more information, see Publish Configuration.

Channel-specific application configuration in Adobe Campaign

Your mobile application is now ready to be used in Campaign for push notification or In-app deliveries. You can also configure the app to create events that will trigger your in-app messages and/or upload Push certificates.

  1. From the advanced menu, select Administration > Channels > BETA:Mobile app (SDK V5).

  2. Select the mobile application you created and configured in Adobe Launch.

  3. In the Mobile application properties tab, add the events that are available in your mobile application for your in-app messages.

  4. To start configuring your events, click Create Element.

    launch_25
  5. Type a name and a description.

    launch_26
  6. Click Add.

    Your event is now available in the Triggers tab when creating an In-App message. For more information, see Preparing and sending a push notification.

  7. In the Device-specific settings section of a mobile application dashboard, for each device, type the application details.

     

    Note:

    This includes the certificate for iOS and the server key for Android.

    After your certificate is uploaded, a message notifies you whether the upload was successful. This message also includes the expiration date of your certificate.

  8. To display a list of subscribers and information about these subscribers, such as whether they opted out of your notifications, click the Mobile application subscribers tab.

Deleting your Adobe Launch application

Caution:

Deleting your Adobe Launch application cannot be reversed.

After your application has been deleted, in Adobe Campaign, verify that your application's property status has been changed to Deleted in Launch.

To completely remove this application from Adobe Campaign, click on your application, and click Delete from Campaign.

launch_27

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy