adobe-marketing-cloud/aep-sdks-documentation

Documentation repository for the Adobe Experience Platform Mobile SDKs

description
Welcome to the home of Adobe Experience Platform Mobile SDK documentation.

{% hint style="info" %}

The Mobile SDK documentation has moved!

The Adobe Experience Platform Mobile SDK documentation has now moved. The latest version of the documentation can be found at https://developer.adobe.com/client-sdks/documentation/.

{% endhint %}

{% hint style="success" %}

Good to go for iOS 16 and Android 13

Latest versions of the Adobe Experience Platform SDK for Google Android and Apple iOS (Swift & Objective-C) are tested for compatibilit with release verisons of Apple iOS 16 and Google Android 13. See Current SDK Versions to find our latest SDK versions or release notes for information on changes and updates.

{% endhint %}

{% hint style="success" %}

Project Griffon will be Assurance!

We're pleased to announce that Project Griffon will be generally available to all Adobe Experience Cloud customers as Assurance. To learn more about this transition see here.

{% endhint %}

Bring the Adobe Experience Cloud to your apps

The Adobe Experience Platform Mobile SDK helps power Adobe's Experience Cloud solutions and services in your mobile apps.

The SDK is comprised of the Mobile Core and a series of modular Adobe Experience Cloud solutions or third-party vendor extensions that depend on the Mobile Core. Extensions interact with the Mobile Core to provide features specific to the solution or service they represent.

Experience Platform Mobile SDKs are available for Android, iOS, and a variety of cross-platform development frameworks. SDKs configuration is managed via Adobe Experience Platform Launch for flexible configuration and extensible, rules-based integrations.

Supported Platforms

The Adobe Experience Platform Mobile SDK provides support for the following platforms:

• Android (see Current SDK versions for download links)
• iOS - Swift (New! - see Current SDK versions for repos, download links)
• iOS - Objective C (includes iOS, iPadOS, and tvOS) (see Current SDK versions for download links)
• Cordova (see Current SDK versions for download links)
• React Native (AEP 1.x) (see Current SDK versions for download links)
• React Native (ACP 2.x) (see Current SDK versions for download links)
• Flutter (in beta, see Current SDK versions for download links)
• Unity (see Current SDK versions for download links)
• WeChat Mini Programs
• Xamarin (see Current SDK versions for download links)

{% hint style="info" %}

Interested in Kotlin?

We're looking for feedback on how we can better support our customers using (or planning to use) Kotlin in their mobile apps.

Please take a quick survey a let us know if you're interested in a Kotlin-based version of the Adobe Experience Platform Mobile SDK. {% endhint %}

{% hint style="warning" %}

End of support for Adobe Experience Platform Mobile SDK plugins for Unity

Effective March 30, 2022, support for Adobe Experience Platform Mobile SDKs on Unity is no longer active. While you may continue using our libraries, Adobe no longer plans to update, modify, or provide support for these libraries. Please contact your Adobe CSM for details. {% endhint %}

Quick Links

• Getting started
• Getting the Experience Platform SDKs
• Frequently asked questions
• Why use the Adobe Experience Platform Mobile SDK?

Further Help

• Visit the SDK community forum to ask questions
• Contact Adobe Experience Cloud customer care for immediate assistance

aep-sdks-documentation's Issues

Confusing instructions

The instructions for Initializing the SDK are quite confusing. The tip says:

Tip: We recommend SDK initialization via native code in your AppDelegate and MainApplication in iOS and Android, respectively. You may also initialize the SDK in Javascript (React Native).

The native code link takes the user to the React-Native implementation, which would be the opposite of what you are recommending the developer do.

Perhaps that tip could be updated to:

Tip: We recommend SDK initialization via native code in your AppDelegate and MainApplication in iOS and Android, respectively. You may also initialize the SDK in Javascript (React Native).

How i setTntId method Target user ID (also known as the tntId) Using ACP 2.X (OBJECTIVE-C).

Using ACP 2.X (OBJECTIVE-C).

In ACPTarget.h file we have below getter methods.

• (void) getThirdPartyId: (nonnull void (^) (NSString* __nullable thirdPartyId)) callback;
• (void) getTntId: (nonnull void (^) (NSString* __nullable tntId)) callback;

And setter method setThirdpartyID is there.

• (void) setThirdPartyId: (nullable NSString*) thirdPartyId;
  when i try to find setTntid method its not found.
  But I need to set Target user ID (also known as the tntId) tntID.
  So How I get these tntId is it coming (getting) automatically or any other option .?
  Please help me.

Different lifecycle tracking behaviours

Base on documentation

We need to implement

   @Override  
   public void onResume() {  
      MobileCore.setApplication(getApplication());
      MobileCore.lifecycleStart(null);
   }

and

   @Override
   public void onPause() {
      MobileCore.lifecyclePause();
   }

for each Activity classes on Android.

However for iOS

- (void) sceneWillEnterForeground:(UIScene *)scene {
   [ACPCore lifecycleStart:nil];
}

and

- (void) sceneDidEnterBackground:(UIScene *)scene {
   [ACPCore lifecyclePause];
}

 - (void) applicationDidEnterBackground:(UIApplication *)application {
    [ACPCore lifecyclePause];
 }

- (void) applicationWillEnterForeground:(UIApplication *)application {
    [ACPCore lifecycleStart:nil];
}

---

I think this two implementation will have a different behaviors.

For IOS library have a global application lifecycle tracking for Android doesn't.

Is it possible to track sessions similar with iOS way? Because each navigation between activities creating a new session on Android.

Adobe SDKs licences

Where I can find the SDKs licences?

We use cashapp licences plugin and we get next output:

com.adobe.marketing.mobile:analytics:2.0.1
 - ERROR: Unknown license name 'The Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:assurance:2.0.1
 - ERROR: Unknown license name 'Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:core:2.0.1
 - ERROR: Unknown license name 'The Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:identity:2.0.1
 - ERROR: Unknown license name 'The Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:lifecycle:2.0.1
 - ERROR: Unknown license name 'The Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:signal:2.0.1
 - ERROR: Unknown license name 'The Apache License, Version 2.0' with no URL is NOT allowed
com.adobe.marketing.mobile:userprofile:2.0.0
 - ERROR: Unknown license name 'Adobe Proprietary' with no URL is NOT allowed

The first is fixable with additional configuration of the plugin. However, we already allowed Apache license at our build the only difference I see that Adobe is not using SPDX identifier properly (hard to say without having access to the source code). You can check how kotlin team specifies licences for the own libraries.

The second error about Adobe Proprietary - can I read something about it? Can you specify for this library in pom like other libraries do?

Context Data Link is Broken

The link to learn more about 'context data' used in the Adobe Analytics Mobile Core SDK is broken.

Documentation Location

https://github.com/Adobe-Marketing-Cloud/aep-sdks-documentation/blob/master/foundation-extensions/mobile-core/mobile-core-api-reference.md#additional-information

Broken Link

https://marketing.adobe.com/resources/help/en_US/sc/implement/context_data_variables.html

Was hoping to include some documentation in my own project about how context data should be used, and would like to use the canonical source.

Dead YouTube link on /beta/adobe-experience-platform-mini-programs-sdk/implementation.md

The YouTube link on the page /beta/adobe-experience-platform-mini-programs-sdk/implementation.md is dead. Please update. Thanks.

Missing swift example

Please provide instruction code in Swift for appending visitor information to the URL that is being used to open the web view

https://aep-sdks.gitbook.io/docs/foundation-extensions/mobile-core/identity#implementing-visitor-tracking-between-an-app-and-the-mobile-web

Provide additional examples for setup analytics with named configuration

Issue:
Documentation does't provide example how to use configuration with different file name. https://github.com/Adobe-Marketing-Cloud/aep-sdks-documentation/blob/master/using-mobile-extensions/adobe-analytics/README.md

With default name configuration ("ADBMobileConfig.json") placed in assets folder all works with expected behaviour. But, if we changing a name of one to "ADBMobileConfigV5.json" and still keeping it n assets it doesn't work

MobileCore.configureWithFileInPath("ADBMobileConfigV5.json")

Please provide an example into documentation file.

Core library version is 1.5.8

[ Android ] - AGP 7.2.0 can no longer access sdks bundled in Mobile Core

Previously (as stated in the docs), using Android Gradle Plugin 7.1.3 would allow project files to use classes from Identity, Lifecycle, and Signal directly. After upgrading to Android Gradle Plugin 7.2.0, those dependencies now have to be added directly for Android studio to see them.

Interestingly, building the project from the command line still works just fine, so this is purely an IDE issue.

collectLaunchInfo missing Android code snippets/reference

Please see: https://github.com/Adobe-Marketing-Cloud/aep-sdks-documentation/blob/master/using-mobile-extensions/mobile-core/mobile-core-api-reference.md#collect-launch-information

Push notification report tracking doesn’t work

Push notification tracking doesn’t work, no report data shows up, nor are there outbound analytics calls for Mobile services. Verified using Adobe assurance.

Response example for "signalWithData" method

In this page using-mobile-extensions/adobe-audience-manager/audience-manager-api-reference.md it would be useful to have an example of the data available in the callback of the method "signalWithData"

iOS documentation links pointing to ACP instead of AEP - cannot find libraries

I am using SPM and cannot find AEPMobileServices.
The current documentation has the AEP badge but it is redirecting to ACP.

Does it even exist? -- Cannot find it in the list of repos.

Server API Documentation

Hello, there's currently a gap in documentation on how to send events to assurance when using the server api. This page mentions that I can use the same mechanism as the Experience Platform Debugger, but doesn't mention what that is.

It also says I can create a assurance session and use that session ID in my edge requests, but doesn't clarify what exactly to do with that value. I'd appreciate any guidance.

Here is the documentation for the server api for reference https://experienceleague.adobe.com/docs/experience-platform/edge-network-server-api/troubleshooting.html?lang=en

Documentation for Visual Preview collectLaunchInfo has a potential typo

I'm not 100% sure of the full API surface but I can't find the method collectLaunchIInfo as referenced in the Android tab for VisualPreview.

On Android, when the application is launched as a result of a deep link, the collectLaunchIInfo API is internally invoked, and the Target activity and deep link information is extracted from the Intent extras.

Looks like the change was introduced in a bigger piece about correcting the documentation so could be a simple typo that was missed PR#220.

I think the documentation should refer to collectLaunchInfo from the MobileCore class. Is that correct? I'm happy to raise a PR for correction if that is the case.

SPM Collection DOES NOT WORK due to invalid signature

As the title says, the collection link shared in the docs does not work.
https://opensource.adobe.com/aepsdk-core-ios/swift/packages/aep.json

It produces the "invalidSignature" error.

SignalWithData always returns AEPError.callbacktimout (iOS)

While trying to implement signalwithdata I am always receiving AEPError.callbacktimout.
What I know:

• Calls are being sent successfully and returning valid responses
• Response time is around 200-500ms
• The default timeout is 2s however while testing it i configured it up to 30s (30000ms)

The method that handles this request always returns the same error code regardless of what else could go wrong preventing me from debugging the issue further.

I am using the code snippet from the example to call this method.

[AEPMobileAudience signalWithData:params completion:^(NSDictionary<NSString *,NSString *> * _Nullable response, NSError * _Nullable error) {
if (error){
// handle error here
}
else{
// handle the returned visitorProfile here
}
}];

Potentially Confusing Issue with ACS Android Docs

Set up in-app messages and local notifications sections only have Android-specific information. Can we put these steps into iOS/Android tabs (and mark iOS as n/a) or mark the section as Android-only to avoid user confusion?

Sdk Tracking Activity bundle Data

Recenlty i integrated the AEP SDK in Android , i see the AEP sdk is collecting activities bundle's data which i'm passing from one activity to another. I want to prevent this tracking ? Please let me know how to handle this.
Please check the logs for more reference:
AdobeExperienceSDK: Core - collectData: generic data OS event dispatched.
AdobeExperienceSDK: EventBus(EventHub) - Processing event #32: {
class: Event,
name: CollectData,
eventNumber: 32,
source: com.adobe.eventsource.os,
type: com.adobe.eventtype.generic.data,
pairId: null,
timestamp: 1621421190625,
data: {
"Name" : "John"
"Email" : "[email protected]"
}
}

Broken links in getting-started/create-a-mobile-property

There are a couple of broken links in https://aep-sdks.gitbook.io/docs/getting-started/create-a-mobile-property:

https://docs.adobelaunch.com/publishing/approval-workflow#library-state - 404
Should point to here possibly: https://docs.adobelaunch.com/getting-started-1/validate-and-publish#publish-to-production

https://docs.adobelaunch.com/administration/user-permissions - 404
Should point to here: https://docs.adobelaunch.com/launch-reference/administration/user-permissions

Signal Extension

https://aep-sdks.gitbook.io/docs/using-mobile-extensions/mobile-core/signals/signals-extension-and-rules-engine-integration

What is the "Signals extension"? Did it used to be a separate extension, but is now just part of the Core extension? It's a little confusing to refer to this as an extension since it doesn't appear in Launch as an installable extension.

Also, there are several examples on this page that are completely blank. Can the examples be re-added?

i18n support

Problem

Since the start of the Launch platform and the new SDK, the documentation for the mobile SDKs changed from https://marketing.adobe.com/resources/help/en_US/mobile/ios to https://aep-sdks.gitbook.io/docs/
(There's apparently been more migrations, but I didn't keep track). All of this seems to reflect the drop of support for DTM and the 4.x SDKs (see https://medium.com/launch-by-adobe/dtm-plans-for-a-sunset-3c6aab003a6f for DTM. I actually don't know the EOL planned for the 4.x SDKs)

However, the documentation here doesn't seem to support internationalisation like the old docs used to. Is there any ETA for a translation support?

Thanks!

Examples

Drop of support announced in Sept 2018

I'm currently working with a Japanese team, and the docs for the Analytics SDK (4.x) tells us that the new Launch platform and SDKs are available and invites us to switch, but no resources in Japanese are available in the links provided.

重要：2018 年 9 月に、SDK の新しいメジャーバージョンをリリースしました。(........)

https://marketing.adobe.com/resources/help/ja_JP/mobile/ios/analytics_main.html

Comparison

For example, the "Analytics -> Product variable" page, available in JP for 4.x : https://marketing.adobe.com/resources/help/ja_JP/mobile/ios/products.html

But only in EN for the new version : https://aep-sdks.gitbook.io/docs/using-mobile-extensions/adobe-analytics/product-variable

(Funnily enough, the 4.x docs in Japanese provides a "Switch language" in the bottom right, but switching back to EN offers a blank page. The old documentation seems to have moved. Although that's an entirely different problem)